User API Doc

DNACenterAPI

The DNACenterAPI class creates “connection objects” for working with the DNA Center APIs and hierarchically organizes the DNA Center APIs and their endpoints underneath these connection objects.

DNACenterAPI summary structure

v1.2.10 summary

DNACenterAPI

authentication

authentication_api()

clients

get_client_detail() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

custom_caller

add_api() call_api()

devices

add_device() delete_device_by_id() export_device_list() get_all_interfaces() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_wireless_lan_controller_details_by_id() register_device_for_wsa() retrieves_all_network_devices() sync_devices() sync_devices_using_forcesync() update_device_role()

fabric_wired

adds_border_device() deletes_border_device() gets_border_device_detail()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

network_discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

networks

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

non_fabric_wireless

create_and_provision_ssid() create_enterprise_ssid() delete_and_provision_ssid() delete_enterprise_ssid() get_enterprise_ssid()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

site_profile

get_device_details_by_ip() provision_nfv()

sites

assign_device_to_site() create_site() get_site_health()

swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

template_programmer

create_project() create_template() delete_project() delete_template() deploy_template() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() preview_template() update_project() update_template() version_template()

v1.3.0 summary

DNACenterAPI

authentication

authentication_api()

clients

get_client_detail() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

custom_caller

add_api() call_api()

devices

add_device() delete_device_by_id() export_device_list() get_all_interfaces() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_wireless_lan_controller_details_by_id() register_device_for_wsa() retrieves_all_network_devices() sync_devices() sync_devices_using_forcesync() update_device_role()

fabric_wired

adds_border_device_in_sda_fabric() deletes_border_device_from_sda_fabric() gets_border_device_details_from_sda_fabric()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

network_discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

networks

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

non_fabric_wireless

create_and_provision_ssid() create_enterprise_ssid() create_wireless_profile() delete_and_provision_ssid() delete_enterprise_ssid() delete_wireless_profile() get_enterprise_ssid() get_wireless_profile() provision() update_provision() update_wireless_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

site_profile

get_device_details_by_ip() nfv_provisioning_detail() provision_nfv()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

template_programmer

create_project() create_template() delete_project() delete_template() deploy_template() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() preview_template() update_project() update_template() version_template()

v1.3.1 summary

DNACenterAPI

application_policy

create_application() create_application_set() delete_application() delete_application_set() edit_application() get_application_sets() get_application_sets_count() get_applications() get_applications_count()

authentication

authentication_api()

clients

get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

configuration_templates

create_project() create_template() delete_project() delete_template() deploy_template() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

devices

add_device() delete_device_by_id() export_device_list() get_all_interfaces() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_wireless_lan_controller_details_by_id() register_device_for_wsa() retrieves_all_network_devices() sync_devices() sync_devices_using_forcesync() update_device_role()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_event_subscriptions() delete_event_subscriptions() get_event_subscriptions() get_events() get_notifications() get_status_api_for_events() update_event_subscriptions()

fabric_wired

add_default_authentication_profile() add_edge_device() add_ip_pool_in_sda_virtual_network() add_port_assignment_for_user_device() adds_border_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_port_assignment_for_user_device() deletes_border_device() get_default_authentication_profile() get_edge_device() get_ip_pool_from_sda_virtual_network() get_port_assignment_for_user_device() gets_border_device_detail() update_default_authentication_profile()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

issues

get_issue_enrichment_details()

network_discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

network_discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

network_settings

delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_service_provider_details()

non_fabric_wireless

ap_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_wireless_profile() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_enterprise_ssid() get_wireless_profile() provision() provision_update() retrieve_rf_profiles() update_wireless_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

site_design

get_device_details_by_ip() nfv_provisioning_detail() provision_nfv()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

v1.3.3 summary

DNACenterAPI

application_policy

create_application() create_application_set() delete_application() delete_application_set() edit_application() get_application_sets() get_application_sets_count() get_applications() get_applications_count()

authentication

authentication_api()

clients

get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

configuration_templates

create_project() create_template() delete_project() delete_template() deploy_template() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

devices

add_device() delete_device_by_id() export_device_list() get_all_interfaces() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_wireless_lan_controller_details_by_id() register_device_for_wsa() retrieves_all_network_devices() sync_devices() sync_devices_using_forcesync() update_device_role()

discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_event_subscriptions() delete_event_subscriptions() get_event_subscriptions() get_events() get_notifications() get_status_api_for_events() update_event_subscriptions()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

issues

get_issue_enrichment_details()

network_settings

assign_credential_to_site() create_device_credentials() create_global_pool() create_network() create_sp_profile() delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_network() get_service_provider_details() update_device_credentials() update_global_pool() update_network() update_sp_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_fabric() add_ip_pool_in_sda_virtual_network() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_sda_fabric() delete_site() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_edge_device() get_ip_pool_from_sda_virtual_network() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_sda_fabric_info() get_site() get_vn() gets_border_device_detail() update_default_authentication_profile()

site_design

get_device_details_by_ip() nfv_provisioning_detail() provision_nfv()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

wireless

ap_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_wireless_profile() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_enterprise_ssid() get_wireless_profile() provision() provision_update() retrieve_rf_profiles() update_wireless_profile()

v2.1.1 summary

DNACenterAPI

application_policy

create_application() create_application_set() delete_application() delete_application_set() edit_application() get_application_sets() get_application_sets_count() get_applications() get_applications_count()

authentication

authentication_api()

clients

get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

configuration_templates

create_project() create_template() delete_project() delete_template() deploy_template() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

device_replacement

deploy_device_replacement_workflow() mark_device_for_replacement() return_replacement_devices_count() return_replacement_devices_with_details() unmark_device_for_replacement()

devices

add_device() delete_device_by_id() export_device_list() get_all_interfaces() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_wireless_lan_controller_details_by_id() register_device_for_wsa() retrieves_all_network_devices() sync_devices() sync_devices_using_forcesync() update_device_role()

discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_event_subscriptions() delete_event_subscriptions() get_event_subscriptions() get_events() get_notifications() get_status_api_for_events() update_event_subscriptions()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

issues

get_issue_enrichment_details()

itsm

get_failed_itsm_events() retry_integration_events()

network_settings

assign_credential_to_site() create_device_credentials() create_global_pool() create_network() create_sp_profile() delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_network() get_service_provider_details() update_device_credentials() update_global_pool() update_network() update_sp_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_fabric() add_ip_pool_in_sda_virtual_network() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_sda_fabric() delete_site() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_edge_device() get_ip_pool_from_sda_virtual_network() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_sda_fabric_info() get_site() get_vn() gets_border_device_detail() update_default_authentication_profile()

site_design

create_nfv_profile() delete_nfv_profile() get_device_details_by_ip() get_nfv_profile() nfv_provisioning_detail() provision_nfv() update_nfv_profile()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

wireless

ap_provision() ap_provision_and_re_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_wireless_profile() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_enterprise_ssid() get_wireless_profile() provision() provision_update() retrieve_rf_profiles() update_wireless_profile()

v2.1.2 summary

DNACenterAPI

application_policy

create_application() create_application_set() delete_application() delete_application_set() edit_application() get_application_sets() get_application_sets_count() get_applications() get_applications_count()

applications

applications()

authentication

authentication_api()

clients

get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

configuration_archive

export_device_configurations()

configuration_templates

create_project() create_template() delete_project() delete_template() deploy_template() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

device_replacement

deploy_device_replacement_workflow() mark_device_for_replacement() return_replacement_devices_count() return_replacement_devices_with_details() unmark_device_for_replacement()

devices

add_device() delete_device_by_id() devices() export_device_list() get_all_interfaces() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_wireless_lan_controller_details_by_id() register_device_for_wsa() retrieves_all_network_devices() sync_devices() sync_devices_using_forcesync() threat_detail_count() threat_details() threat_summary() update_device_role()

discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_event_subscriptions() delete_event_subscriptions() get_event_subscriptions() get_events() get_notifications() get_status_api_for_events() update_event_subscriptions()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

issues

get_issue_enrichment_details() issues()

itsm

get_failed_itsm_events() retry_integration_events()

network_settings

assign_credential_to_site() create_device_credentials() create_global_pool() create_network() create_sp_profile() delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_network() get_service_provider_details() update_device_credentials() update_global_pool() update_network() update_sp_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_fabric() add_ip_pool_in_sda_virtual_network() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_sda_fabric() delete_site() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_device_role_in_sda_fabric() get_edge_device() get_ip_pool_from_sda_virtual_network() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_sda_fabric_count() get_sda_fabric_info() get_site() get_vn() gets_border_device_detail() update_default_authentication_profile()

sensors

create_sensor_test_template() delete_sensor_test() duplicate_sensor_test_template() edit_sensor_test_template() run_now_sensor_test() sensors()

site_design

create_nfv_profile() delete_nfv_profile() get_device_details_by_ip() get_nfv_profile() nfv_provisioning_detail() provision_nfv() update_nfv_profile()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

wireless

ap_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_wireless_profile() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_enterprise_ssid() get_wireless_profile() provision() provision_update() retrieve_rf_profiles() sensor_test_results() update_wireless_profile()

v2.2.1 summary

DNACenterAPI

application_policy

create_application() create_application_set() delete_application() delete_application_set() edit_application() get_application_sets() get_application_sets_count() get_applications() get_applications_count()

applications

applications()

authentication

authentication_api()

clients

client_proximity() get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

compliance

compliance_details_of_device() device_compliance_status() get_compliance_status() run_compliance()

configuration_archive

export_device_configurations()

configuration_templates

create_project() create_template() delete_project() delete_template() deploy_template() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

device_replacement

deploy_device_replacement_workflow() mark_device_for_replacement() return_replacement_devices_count() return_replacement_devices_with_details() unmark_device_for_replacement()

devices

add_device() delete_device_by_id() devices() export_device_list() get_all_interfaces() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_wireless_lan_controller_details_by_id() poe_details() register_device_for_wsa() retrieves_all_network_devices() return_power_supply_fan_details_for_the_given_device() sync_devices() sync_devices_using_forcesync() threat_detail_count() threat_details() threat_summary() update_device_role()

discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_email_event_subscription() create_event_subscriptions() create_rest_webhook_event_subscription() create_syslog_event_subscription() delete_event_subscriptions() eventartifact_count() get_auditlog_parent_records() get_auditlog_records() get_auditlog_summary() get_email_event_subscriptions() get_email_subscription_details() get_event_subscriptions() get_eventartifacts() get_events() get_notifications() get_rest_webhook_event_subscriptions() get_rest_webhook_subscription_details() get_status_api_for_events() get_syslog_event_subscriptions() get_syslog_subscription_details() update_email_event_subscription() update_event_subscriptions() update_rest_webhook_event_subscription() update_syslog_event_subscription()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

issues

get_issue_enrichment_details() issues()

itsm

get_cmdb_sync_status() get_failed_itsm_events() retry_integration_events()

network_settings

assign_credential_to_site() create_device_credentials() create_global_pool() create_network() create_sp_profile() delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_network() get_reserve_ip_subpool() get_service_provider_details() release_reserve_ip_subpool() reserve_ip_subpool() update_device_credentials() update_global_pool() update_network() update_reserve_ip_subpool() update_sp_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

reports

create_or_schedule_a_report() delete_a_scheduled_report() download_report_content() get_a_scheduled_report() get_all_execution_details_for_a_given_report() get_all_view_groups() get_list_of_scheduled_reports() get_view_details_for_a_given_view_group_and_view() get_views_for_a_given_view_group()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_fabric() add_ip_pool_in_sda_virtual_network() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_sda_fabric() delete_site() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_device_role_in_sda_fabric() get_edge_device() get_ip_pool_from_sda_virtual_network() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_sda_fabric_count() get_sda_fabric_info() get_site() get_vn() gets_border_device_detail() update_default_authentication_profile()

security_advisories

get_advisories_list() get_advisories_per_device() get_advisories_summary() get_advisory_ids_per_device() get_devices_per_advisory()

sensors

create_sensor_test_template() delete_sensor_test() duplicate_sensor_test_template() edit_sensor_test_template() run_now_sensor_test() sensors()

site_design

create_nfv_profile() delete_nfv_profile() get_device_details_by_ip() get_nfv_profile() nfv_provisioning_detail() provision_nfv() update_nfv_profile()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

wireless

ap_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_wireless_profile() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_enterprise_ssid() get_wireless_profile() provision() provision_update() retrieve_rf_profiles() sensor_test_results() update_wireless_profile()

v2.2.2.3 summary

DNACenterAPI

application_policy

create_application() create_application_set() delete_application() delete_application_set() edit_application() get_application_sets() get_application_sets_count() get_applications() get_applications_count()

applications

applications()

authentication_management

import_certificate() import_certificate_p12()

authentication

authentication_api()

clients

client_proximity() get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

compliance

compliance_details_of_device() device_compliance_status() get_compliance_detail() get_compliance_detail_count() get_compliance_status() get_compliance_status_count() run_compliance()

configuration_archive

export_device_configurations()

configuration_templates

clone_given_template() create_project() create_template() deletes_the_project() deletes_the_template() deploy_template() deploy_template_v2() export_projects() export_templates() get_project_details() get_projects() get_template_deployment_status() get_template_details() get_template_versions() gets_the_templates_available() imports_the_projects_provided() imports_the_templates_provided() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

device_replacement

deploy_device_replacement_workflow() mark_device_for_replacement() return_replacement_devices_count() return_replacement_devices_with_details() unmark_device_for_replacement()

devices

add_device() delete_device_by_id() devices() export_device_list() get_all_interfaces() get_chassis_details_for_device() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_devices_with_snmpv3_des() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_linecard_details() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_stack_details_for_device() get_supervisor_card_detail() get_wireless_lan_controller_details_by_id() inventory_insight_device_link_mismatch() poe_details() poe_interface_details() register_device_for_wsa() retrieves_all_network_devices() return_power_supply_fan_details_for_the_given_device() sync_devices() sync_devices_using_forcesync() threat_detail_count() threat_details() threat_summary() update_device_role()

discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_email_event_subscription() create_event_subscriptions() create_rest_webhook_event_subscription() create_syslog_event_subscription() delete_event_subscriptions() eventartifact_count() get_auditlog_parent_records() get_auditlog_records() get_auditlog_summary() get_email_event_subscriptions() get_email_subscription_details() get_event_subscriptions() get_eventartifacts() get_events() get_notifications() get_rest_webhook_event_subscriptions() get_rest_webhook_subscription_details() get_status_api_for_events() get_syslog_event_subscriptions() get_syslog_subscription_details() update_email_event_subscription() update_event_subscriptions() update_rest_webhook_event_subscription() update_syslog_event_subscription()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

health_and_performance

system_health() system_health_count() system_performance() system_performance_historical()

issues

get_issue_enrichment_details() issues()

itsm

get_cmdb_sync_status() get_failed_itsm_events() retry_integration_events()

licenses

change_virtual_account() device_count_details() device_deregistration() device_license_details() device_license_summary() device_registration() license_term_details() license_usage_details() smart_account_details() virtual_account_details()

network_settings

assign_credential_to_site() create_device_credentials() create_global_pool() create_network() create_sp_profile() delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_network() get_reserve_ip_subpool() get_service_provider_details() release_reserve_ip_subpool() reserve_ip_subpool() update_device_credentials() update_global_pool() update_network() update_reserve_ip_subpool() update_sp_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

platform_configuration

nodes_configuration_summary() release_summary()

reports

create_or_schedule_a_report() delete_a_scheduled_report() download_report_content() get_a_scheduled_report() get_all_execution_details_for_a_given_report() get_all_view_groups() get_list_of_scheduled_reports() get_view_details_for_a_given_view_group_and_view() get_views_for_a_given_view_group()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_fabric() add_ip_pool_in_sda_virtual_network() add_multicast_in_sda_fabric() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_virtual_network_with_scalable_groups() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_multicast_from_sda_fabric() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_provisioned_wired_device() delete_sda_fabric() delete_site() delete_virtual_network_with_scalable_groups() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_device_role_in_sda_fabric() get_edge_device() get_ip_pool_from_sda_virtual_network() get_multicast_details_from_sda_fabric() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_provisioned_wired_device() get_sda_fabric_count() get_sda_fabric_info() get_site() get_virtual_network_with_scalable_groups() get_vn() gets_border_device_detail() provision_wired_device() update_default_authentication_profile() update_virtual_network_with_scalable_groups()

security_advisories

get_advisories_list() get_advisories_per_device() get_advisories_summary() get_advisory_ids_per_device() get_devices_per_advisory()

sensors

create_sensor_test_template() delete_sensor_test() duplicate_sensor_test_template() edit_sensor_test_template() run_now_sensor_test() sensors()

site_design

create_floormap() create_nfv_profile() delete_floormap() delete_nfv_profile() get_device_details_by_ip() get_floormap() get_floormaps() get_nfv_profile() nfv_provisioning_detail() provision_nfv() update_floormap() update_nfv_profile()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_software_image_details() import_local_software_image() import_software_image_via_url() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

wireless

ap_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_update_dynamic_interface() create_wireless_profile() delete_dynamic_interface() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_dynamic_interface() get_enterprise_ssid() get_wireless_profile() provision() provision_update() psk_override() retrieve_rf_profiles() sensor_test_results() update_enterprise_ssid() update_wireless_profile()

v2.2.3.3 summary

DNACenterAPI

application_policy

application_policy_intent() create_application() create_application_policy_queuing_profile() create_application_set() create_qos_device_interface_info() delete_application() delete_application_policy_queuing_profile() delete_application_set() delete_qos_device_interface_info() edit_application() get_application_policy() get_application_policy_default() get_application_policy_queuing_profile() get_application_policy_queuing_profile_count() get_application_sets() get_application_sets_count() get_applications() get_applications_count() get_qos_device_interface_info() get_qos_device_interface_info_count() update_application_policy_queuing_profile() update_qos_device_interface_info()

applications

applications()

authentication_management

import_certificate() import_certificate_p12()

authentication

authentication_api()

clients

client_proximity() get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

compliance

compliance_details_of_device() device_compliance_status() get_compliance_detail() get_compliance_detail_count() get_compliance_status() get_compliance_status_count() run_compliance()

configuration_archive

export_device_configurations()

configuration_templates

clone_given_template() create_project() create_template() deletes_the_project() deletes_the_template() deploy_template() deploy_template_v2() export_projects() export_templates() get_project_details() get_projects() get_projects_details() get_template_deployment_status() get_template_details() get_template_versions() get_templates_details() gets_the_templates_available() imports_the_projects_provided() imports_the_templates_provided() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

device_replacement

deploy_device_replacement_workflow() mark_device_for_replacement() return_replacement_devices_count() return_replacement_devices_with_details() unmark_device_for_replacement()

devices

add_device() delete_device_by_id() devices() export_device_list() get_all_interfaces() get_chassis_details_for_device() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_device_values_that_match_fully_or_partially_an_attribute() get_devices_with_snmpv3_des() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_linecard_details() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_stack_details_for_device() get_supervisor_card_detail() get_wireless_lan_controller_details_by_id() inventory_insight_device_link_mismatch() poe_details() poe_interface_details() register_device_for_wsa() return_power_supply_fan_details_for_the_given_device() sync_devices() sync_devices_using_forcesync() threat_detail_count() threat_details() threat_summary() update_device_role()

disaster_recovery

disaster_recovery_operational_status() disaster_recovery_status()

discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_email_event_subscription() create_event_subscriptions() create_rest_webhook_event_subscription() create_syslog_event_subscription() delete_event_subscriptions() eventartifact_count() get_auditlog_parent_records() get_auditlog_records() get_auditlog_summary() get_email_event_subscriptions() get_email_subscription_details() get_event_subscriptions() get_eventartifacts() get_events() get_notifications() get_rest_webhook_event_subscriptions() get_rest_webhook_subscription_details() get_status_api_for_events() get_syslog_event_subscriptions() get_syslog_subscription_details() update_email_event_subscription() update_event_subscriptions() update_rest_webhook_event_subscription() update_syslog_event_subscription()

fabric_wireless

add_ssid_to_ip_pool_mapping() add_w_l_c_to_fabric_domain() get_ssid_to_ip_pool_mapping() remove_w_l_c_from_fabric_domain() update_ssid_to_ip_pool_mapping()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files()

health_and_performance

system_health() system_health_count() system_performance() system_performance_historical()

issues

get_issue_enrichment_details() issues()

itsm

get_cmdb_sync_status() get_failed_itsm_events() retry_integration_events()

licenses

change_virtual_account() device_count_details() device_deregistration() device_license_details() device_license_summary() device_registration() license_term_details() license_usage_details() smart_account_details() virtual_account_details()

network_settings

assign_credential_to_site() create_device_credentials() create_global_pool() create_network() create_sp_profile() delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_network() get_reserve_ip_subpool() get_service_provider_details() release_reserve_ip_subpool() reserve_ip_subpool() update_device_credentials() update_global_pool() update_network() update_reserve_ip_subpool() update_sp_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

platform_configuration

nodes_configuration_summary() release_summary()

policy

create_a_profiling_rule() delete_an_existing_profiling_rule() get_count_of_profiling_rules() get_details_of_a_single_profiling_rule() get_list_of_profiling_rules() import_profiling_rules_in_bulk() update_an_existing_profiling_rule()

reports

create_or_schedule_a_report() delete_a_scheduled_report() download_report_content() get_a_scheduled_report() get_all_execution_details_for_a_given_report() get_all_view_groups() get_list_of_scheduled_reports() get_view_details_for_a_given_view_group_and_view() get_views_for_a_given_view_group()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_fabric() add_ip_pool_in_sda_virtual_network() add_multicast_in_sda_fabric() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_virtual_network_with_scalable_groups() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_multicast_from_sda_fabric() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_provisioned_wired_device() delete_sda_fabric() delete_site() delete_virtual_network_with_scalable_groups() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_device_role_in_sda_fabric() get_edge_device() get_ip_pool_from_sda_virtual_network() get_multicast_details_from_sda_fabric() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_provisioned_wired_device() get_sda_fabric_count() get_sda_fabric_info() get_site() get_virtual_network_with_scalable_groups() get_vn() gets_border_device_detail() provision_wired_device() re_provision_wired_device() update_default_authentication_profile() update_virtual_network_with_scalable_groups()

security_advisories

get_advisories_list() get_advisories_per_device() get_advisories_summary() get_advisory_ids_per_device() get_devices_per_advisory()

sensors

create_sensor_test_template() delete_sensor_test() duplicate_sensor_test_template() edit_sensor_test_template() run_now_sensor_test() sensors()

site_design

associate() create_floormap() create_nfv_profile() delete_floormap() delete_nfv_profile() disassociate() get_device_details_by_ip() get_floormap() get_floormaps() get_nfv_profile() nfv_provisioning_detail() provision_nfv() update_floormap() update_nfv_profile()

sites

assign_device_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_device_family_identifiers() get_golden_tag_status_of_an_image() get_software_image_details() import_local_software_image() import_software_image_via_url() remove_golden_tag_for_image() tag_as_golden_image() trigger_software_image_activation() trigger_software_image_distribution()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_business_api_execution_details() get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

wireless

ap_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_update_dynamic_interface() create_wireless_profile() delete_dynamic_interface() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_dynamic_interface() get_enterprise_ssid() get_wireless_profile() provision() provision_update() psk_override() retrieve_rf_profiles() sensor_test_results() update_enterprise_ssid() update_wireless_profile()

v2.3.3.0 summary

DNACenterAPI

application_policy

application_policy_intent() create_application() create_application_policy_queuing_profile() create_application_set() create_qos_device_interface_info() delete_application() delete_application_policy_queuing_profile() delete_application_set() delete_qos_device_interface_info() edit_application() get_application_policy() get_application_policy_default() get_application_policy_queuing_profile() get_application_policy_queuing_profile_count() get_application_sets() get_application_sets_count() get_applications() get_applications_count() get_qos_device_interface_info() get_qos_device_interface_info_count() update_application_policy_queuing_profile() update_qos_device_interface_info()

applications

applications()

authentication

authentication_api()

cisco_dna_center_system

authorize_device()

clients

client_proximity() get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

compliance

compliance_details_of_device() device_compliance_status() get_compliance_detail() get_compliance_detail_count() get_compliance_status() get_compliance_status_count() run_compliance()

configuration_archive

export_device_configurations()

configuration_templates

clone_given_template() create_project() create_template() deletes_the_project() deletes_the_template() deploy_template() deploy_template_v2() export_projects() export_templates() get_project_details() get_projects() get_projects_details() get_template_deployment_status() get_template_details() get_template_versions() get_templates_details() gets_the_templates_available() imports_the_projects_provided() imports_the_templates_provided() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

device_replacement

deploy_device_replacement_workflow() mark_device_for_replacement() return_replacement_devices_count() return_replacement_devices_with_details() unmark_device_for_replacement()

devices

add_device() clear_mac_address_table() delete_device_by_id() devices() export_device_list() get_all_interfaces() get_chassis_details_for_device() get_connected_device_detail() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_device_values_that_match_fully_or_partially_an_attribute() get_devices_with_snmpv3_des() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_linecard_details() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_planned_access_points_for_building() get_planned_access_points_for_floor() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_stack_details_for_device() get_supervisor_card_detail() get_wireless_lan_controller_details_by_id() inventory_insight_device_link_mismatch() legit_operations_for_interface() poe_details() poe_interface_details() register_device_for_wsa() return_power_supply_fan_details_for_the_given_device() sync_devices() sync_devices_using_forcesync() update_device_role() update_interface_details()

discovery

create_cli_credentials() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credentials_by_id() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_email_destination() create_email_event_subscription() create_event_subscriptions() create_rest_webhook_event_subscription() create_syslog_destination() create_syslog_event_subscription() create_webhook_destination() delete_event_subscriptions() eventartifact_count() get_auditlog_parent_records() get_auditlog_records() get_auditlog_summary() get_connector_types() get_email_event_subscriptions() get_email_subscription_details() get_event_subscriptions() get_eventartifacts() get_events() get_notifications() get_rest_webhook_event_subscriptions() get_rest_webhook_subscription_details() get_status_api_for_events() get_syslog_event_subscriptions() get_syslog_subscription_details() update_email_destination() update_email_event_subscription() update_event_subscriptions() update_rest_webhook_event_subscription() update_syslog_destination() update_syslog_event_subscription() update_webhook_destination()

fabric_wireless

add_ssid_to_ip_pool_mapping() add_w_l_c_to_fabric_domain() get_ssid_to_ip_pool_mapping() remove_w_l_c_from_fabric_domain() update_ssid_to_ip_pool_mapping2()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files() upload_file()

health_and_performance

system_health() system_health_count() system_performance() system_performance_historical()

issues

get_issue_enrichment_details() issues()

itsm

get_cmdb_sync_status() get_failed_itsm_events() retry_integration_events()

lan_automation

lan_automation() lan_automation2() lan_automation_log() lan_automation_log_by_id() lan_automation_session_count() lan_automation_status() lan_automation_status_by_id()

licenses

change_virtual_account() device_count_details() device_deregistration() device_license_details() device_license_summary() device_registration() license_term_details() license_usage_details() smart_account_details() virtual_account_details()

network_settings

assign_credential_to_site() create_device_credentials() create_global_pool() create_network() create_sp_profile() delete_device_credential() delete_global_ip_pool() delete_sp_profile() get_device_credential_details() get_global_pool() get_network() get_reserve_ip_subpool() get_service_provider_details() release_reserve_ip_subpool() reserve_ip_subpool() update_device_credentials() update_global_pool() update_network() update_reserve_ip_subpool() update_sp_profile()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

platform_configuration

nodes_configuration_summary() release_summary()

reports

create_or_schedule_a_report() delete_a_scheduled_report() download_report_content() get_a_scheduled_report() get_all_execution_details_for_a_given_report() get_all_view_groups() get_list_of_scheduled_reports() get_view_details_for_a_given_view_group_and_view() get_views_for_a_given_view_group()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_ip_pool_in_sda_virtual_network() add_multicast_in_sda_fabric() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_transit_peer_network() add_virtual_network_with_scalable_groups() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_multicast_from_sda_fabric() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_provisioned_wired_device() delete_site() delete_transit_peer_network() delete_virtual_network_with_scalable_groups() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_device_role_in_sda_fabric() get_edge_device() get_ip_pool_from_sda_virtual_network() get_multicast_details_from_sda_fabric() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_provisioned_wired_device() get_site() get_transit_peer_network_info() get_virtual_network_summary() get_virtual_network_with_scalable_groups() get_vn() gets_border_device_detail() provision_wired_device() re_provision_wired_device() update_default_authentication_profile() update_virtual_network_with_scalable_groups()

security_advisories

get_advisories_list() get_advisories_per_device() get_advisories_summary() get_advisory_ids_per_device() get_devices_per_advisory()

sensors

create_sensor_test_template() delete_sensor_test() duplicate_sensor_test_template() edit_sensor_test_template() run_now_sensor_test() sensors()

site_design

associate() create_nfv_profile() delete_nfv_profile() disassociate() get_device_details_by_ip() get_nfv_profile() nfv_provisioning_detail() provision_nfv() update_nfv_profile()

sites

assign_devices_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_device_family_identifiers() get_golden_tag_status_of_an_image() get_software_image_details() import_local_software_image() import_software_image_via_url() remove_golden_tag_for_image() tag_as_golden_image() trigger_software_image_activation() trigger_software_image_distribution()

system_settings

custom_prompt_post_api() custom_prompt_support_get_api()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_business_api_execution_details() get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

users

get_user_enrichment_details()

wireless

ap_provision() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_update_dynamic_interface() create_wireless_profile() delete_dynamic_interface() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_dynamic_interface() get_enterprise_ssid() get_wireless_profile() provision() provision_update() psk_override() retrieve_rf_profiles() sensor_test_results() update_enterprise_ssid() update_wireless_profile()

v2.3.5.3 summary

DNACenterAPI

application_policy

application_policy_intent() create_application() create_application_policy_queuing_profile() create_application_set() create_qos_device_interface_info() delete_application() delete_application_policy_queuing_profile() delete_application_set() delete_qos_device_interface_info() edit_application() get_application_policy() get_application_policy_default() get_application_policy_queuing_profile() get_application_policy_queuing_profile_count() get_application_sets() get_application_sets_count() get_applications() get_applications_count() get_qos_device_interface_info() get_qos_device_interface_info_count() update_application_policy_queuing_profile() update_qos_device_interface_info()

applications

applications()

authentication_management

authentication_ap_i() import_certificate() import_certificate_p12()

authentication

authentication_api()

cisco_dna_center_system

authorize_device()

clients

client_proximity() get_client_detail() get_client_enrichment_details() get_overall_client_health()

command_runner

get_all_keywords_of_clis_accepted() run_read_only_commands_on_devices()

compliance

compliance_details_of_device() device_compliance_status() get_compliance_detail() get_compliance_detail_count() get_compliance_status() get_compliance_status_count() run_compliance()

configuration_archive

export_device_configurations()

configuration_templates

clone_given_template() create_project() create_template() deletes_the_project() deletes_the_template() deploy_template() deploy_template_v2() export_projects() export_templates() get_project_details() get_projects() get_projects_details() get_template_deployment_status() get_template_details() get_template_versions() get_templates_details() gets_the_templates_available() imports_the_projects_provided() imports_the_templates_provided() preview_template() update_project() update_template() version_template()

custom_caller

add_api() call_api()

device_onboarding_pnp

add_a_workflow() add_device() add_virtual_account() claim_a_device_to_a_site() claim_device() delete_device_by_id_from_pnp() delete_workflow_by_id() deregister_virtual_account() get_device_by_id() get_device_count() get_device_history() get_device_list() get_pnp_global_settings() get_smart_account_list() get_sync_result_for_virtual_account() get_virtual_account_list() get_workflow_by_id() get_workflow_count() get_workflows() import_devices_in_bulk() preview_config() reset_device() sync_virtual_account_devices() un_claim_device() update_device() update_pnp_global_settings() update_pnp_server_profile() update_workflow()

device_replacement

deploy_device_replacement_workflow() mark_device_for_replacement() return_replacement_devices_count() return_replacement_devices_with_details() unmark_device_for_replacement()

devices

add_device() add_user_defined_field_to_device() clear_mac_address_table() create_user_defined_field() delete_device_by_id() delete_user_defined_field() devices() export_device_list() get_all_interfaces() get_all_user_defined_fields() get_chassis_details_for_device() get_connected_device_detail() get_device_by_id() get_device_by_serial_number() get_device_config_by_id() get_device_config_count() get_device_config_for_all_devices() get_device_count() get_device_detail() get_device_enrichment_details() get_device_interface_count() get_device_interface_count_by_id() get_device_interface_vlans() get_device_interfaces_by_specified_range() get_device_list() get_device_summary() get_device_values_that_match_fully_or_partially_an_attribute() get_devices_registered_for_wsa_notification() get_devices_with_snmpv3_des() get_functional_capability_by_id() get_functional_capability_for_devices() get_interface_by_id() get_interface_by_ip() get_interface_details() get_interface_info_by_id() get_isis_interfaces() get_linecard_details() get_module_count() get_module_info_by_id() get_modules() get_network_device_by_ip() get_network_device_by_pagination_range() get_organization_list_for_meraki() get_ospf_interfaces() get_planned_access_points_for_building() get_planned_access_points_for_floor() get_polling_interval_by_id() get_polling_interval_for_all_devices() get_stack_details_for_device() get_supervisor_card_detail() get_wireless_lan_controller_details_by_id() inventory_insight_device_link_mismatch() legit_operations_for_interface() poe_details() poe_interface_details() remove_user_defined_field_from_device() return_power_supply_fan_details_for_the_given_device() sync_devices() sync_devices_using_forcesync() update_device_role() update_interface_details() update_user_defined_field()

discovery

create_cli_credentials() create_global_credentials_v2() create_http_read_credentials() create_http_write_credentials() create_netconf_credentials() create_snmp_read_community() create_snmp_write_community() create_snmpv3_credentials() create_update_snmp_properties() delete_all_discovery() delete_discovery_by_id() delete_discovery_by_specified_range() delete_global_credential_v2() delete_global_credentials_by_id() get_all_global_credentials_v2() get_count_of_all_discovery_jobs() get_credential_sub_type_by_credential_id() get_devices_discovered_by_id() get_discovered_devices_by_range() get_discovered_network_devices_by_discovery_id() get_discoveries_by_range() get_discovery_by_id() get_discovery_jobs_by_ip() get_global_credentials() get_list_of_discoveries_by_discovery_id() get_network_devices_from_discovery() get_snmp_properties() start_discovery() update_cli_credentials() update_global_credentials() update_global_credentials_v2() update_http_read_credential() update_http_write_credentials() update_netconf_credentials() update_snmp_read_community() update_snmp_write_community() update_snmpv3_credentials() updates_discovery_by_id()

eo_x

get_eo_x_details_per_device() get_eo_x_status_for_all_devices() get_eo_x_summary()

event_management

count_of_event_subscriptions() count_of_events() count_of_notifications() create_email_destination() create_email_event_subscription() create_event_subscriptions() create_rest_webhook_event_subscription() create_syslog_destination() create_syslog_event_subscription() create_webhook_destination() delete_event_subscriptions() eventartifact_count() get_auditlog_parent_records() get_auditlog_records() get_auditlog_summary() get_connector_types() get_email_destination() get_email_event_subscriptions() get_email_subscription_details() get_event_subscriptions() get_eventartifacts() get_events() get_notifications() get_rest_webhook_event_subscriptions() get_rest_webhook_subscription_details() get_snmp_destination() get_status_api_for_events() get_syslog_destination() get_syslog_event_subscriptions() get_syslog_subscription_details() get_webhook_destination() update_email_destination() update_email_event_subscription() update_event_subscriptions() update_rest_webhook_event_subscription() update_syslog_destination() update_syslog_event_subscription() update_webhook_destination()

fabric_wireless

add_ssid_to_ip_pool_mapping() add_w_l_c_to_fabric_domain() get_ssid_to_ip_pool_mapping() remove_w_l_c_from_fabric_domain() update_ssid_to_ip_pool_mapping()

file

download_a_file_by_fileid() get_list_of_available_namespaces() get_list_of_files() upload_file()

health_and_performance

system_health() system_health_count() system_performance() system_performance_historical()

issues

execute_suggested_actions_commands() get_issue_enrichment_details() issues()

itsm

get_cmdb_sync_status() get_failed_itsm_events() retry_integration_events()

itsm_integration

create_itsm_integration_setting() delete_itsm_integration_setting() get_all_itsm_integration_settings() get_itsm_integration_setting_by_id() update_itsm_integration_setting()

lan_automation

lan_automation_active_sessions() lan_automation_log() lan_automation_log_by_id() lan_automation_logs_for_individual_devices() lan_automation_session_count() lan_automation_start() lan_automation_status() lan_automation_status_by_id() lan_automation_stop()

licenses

change_virtual_account2() device_count_details2() device_deregistration2() device_license_details2() device_license_summary2() device_registration2() license_term_details2() license_usage_details2() smart_account_details() virtual_account_details2()

network_settings

assign_device_credential_to_site() assign_device_credential_to_site_v2() create_device_credentials() create_global_pool() create_network() create_network_v2() create_sp_profile() create_sp_profile_v2() delete_device_credential() delete_global_ip_pool() delete_sp_profile() delete_sp_profile_v2() get_device_credential_details() get_global_pool() get_network() get_network_v2() get_reserve_ip_subpool() get_service_provider_details() get_service_provider_details_v2() release_reserve_ip_subpool() reserve_ip_subpool() update_device_credentials() update_global_pool() update_network() update_network_v2() update_reserve_ip_subpool() update_sp_profile() update_sp_profile_v2()

path_trace

deletes_pathtrace_by_id() initiate_a_new_pathtrace() retrieves_previous_pathtrace() retrives_all_previous_pathtraces_summary()

platform

cisco_dna_center_packages_summary() nodes_configuration_summary() release_summary()

reports

create_or_schedule_a_report() delete_a_scheduled_report() download_report_content() get_a_scheduled_report() get_all_execution_details_for_a_given_report() get_all_view_groups() get_list_of_scheduled_reports() get_view_details_for_a_given_view_group_and_view() get_views_for_a_given_view_group()

sda

add_control_plane_device() add_default_authentication_profile() add_edge_device() add_ip_pool_in_sda_virtual_network() add_multicast_in_sda_fabric() add_port_assignment_for_access_point() add_port_assignment_for_user_device() add_site() add_transit_peer_network() add_virtual_network_with_scalable_groups() add_vn() adds_border_device() delete_control_plane_device() delete_default_authentication_profile() delete_edge_device() delete_ip_pool_from_sda_virtual_network() delete_multicast_from_sda_fabric() delete_port_assignment_for_access_point() delete_port_assignment_for_user_device() delete_provisioned_wired_device() delete_site() delete_transit_peer_network() delete_virtual_network_with_scalable_groups() delete_vn() deletes_border_device() get_control_plane_device() get_default_authentication_profile() get_device_info() get_device_role_in_sda_fabric() get_edge_device() get_ip_pool_from_sda_virtual_network() get_multicast_details_from_sda_fabric() get_port_assignment_for_access_point() get_port_assignment_for_user_device() get_provisioned_wired_device() get_site() get_transit_peer_network_info() get_virtual_network_summary() get_virtual_network_with_scalable_groups() get_vn() gets_border_device_detail() provision_wired_device() re_provision_wired_device() update_default_authentication_profile() update_virtual_network_with_scalable_groups()

security_advisories

get_advisories_list() get_advisories_per_device() get_advisories_summary() get_advisory_ids_per_device() get_devices_per_advisory()

sensors

create_sensor_test_template() delete_sensor_test() duplicate_sensor_test_template() edit_sensor_test_template() run_now_sensor_test() sensors()

site_design

associate() create_nfv_profile() delete_nfv_profile() disassociate() get_device_details_by_ip() get_nfv_profile() nfv_provisioning_detail() provision_nfv() update_nfv_profile()

sites

assign_devices_to_site() create_site() delete_site() get_membership() get_site() get_site_count() get_site_health() update_site()

software_image_management_swim

get_device_family_identifiers() get_golden_tag_status_of_an_image() get_software_image_details() import_local_software_image() import_software_image_via_url() remove_golden_tag_for_image() tag_as_golden_image() trigger_software_image_activation() trigger_software_image_distribution()

system_settings

custom_prompt_post_api() custom_prompt_support_get_api() get_authentication_and_policy_servers()

tag

add_members_to_the_tag() create_tag() delete_tag() get_tag() get_tag_by_id() get_tag_count() get_tag_member_count() get_tag_members_by_id() get_tag_resource_types() remove_tag_member() update_tag() updates_tag_membership()

task

get_business_api_execution_details() get_task_by_id() get_task_by_operationid() get_task_count() get_task_tree() get_tasks()

topology

get_l3_topology_details() get_overall_network_health() get_physical_topology() get_site_topology() get_topology_details() get_vlan_details()

userand_roles

add_user_ap_i() get_external_authentication_servers_ap_i() get_permissions_ap_i() get_roles_ap_i() get_users_ap_i() update_user_ap_i()

users

get_user_enrichment_details()

wireless

ap_provision() configure_access_points() create_and_provision_ssid() create_enterprise_ssid() create_or_update_rf_profile() create_update_dynamic_interface() create_wireless_profile() delete_dynamic_interface() delete_enterprise_ssid() delete_rf_profiles() delete_ssid_and_provision_it_to_devices() delete_wireless_profile() get_access_point_configuration() get_access_point_configuration_task_result() get_access_point_reboot_task_result() get_dynamic_interface() get_enterprise_ssid() get_wireless_profile() provision() provision_update() psk_override() reboot_access_points() retrieve_rf_profiles() sensor_test_results() update_enterprise_ssid() update_wireless_profile()

DNACenterAPI Class

class DNACenterAPI[source]

Cisco DNA Center API wrapper.

Creates a ‘session’ for all API calls through a created DNACenterAPI object. The ‘session’ handles authentication, provides the needed headers, and checks all responses for error conditions.

DNACenterAPI wraps all of the individual DNA Center APIs and represents them in a simple hierarchical structure.

__init__(username=None, password=None, encoded_auth=None, base_url=None, single_request_timeout=None, wait_on_rate_limit=None, verify=None, version=None, debug=None, object_factory=<function mydict_data_factory>, validator=<class 'dnacentersdk.models.schema_validator.SchemaValidator'>)[source]

Create a new DNACenterAPI object. An access token is required to interact with the DNA Center APIs. This package supports two methods for you to generate the authorization token:

1. Provide a encoded_auth value (username:password encoded in base 64). This has priority over the following method

  1. Provide username and password values.

This package supports two methods for you to set those values:

1. Provide the parameter. That is the encoded_auth or username and password parameters.

2. If an argument is not supplied, the package checks for its environment variable counterpart. That is the DNA_CENTER_ENCODED_AUTH, DNA_CENTER_USERNAME, DNA_CENTER_PASSWORD.

When not given enough parameters an AccessTokenError is raised.

Parameters:
  • base_url (basestring) – The base URL to be prefixed to the individual API endpoint suffixes. Defaults to the DNA_CENTER_BASE_URL environment variable or dnacentersdk.config.DEFAULT_BASE_URL if the environment variable is not set.

  • username (basestring) – HTTP Basic Auth username.

  • password (basestring) – HTTP Basic Auth password.

  • encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.

  • single_request_timeout (int) – Timeout (in seconds) for RESTful HTTP requests. Defaults to the DNA_CENTER_SINGLE_REQUEST_TIMEOUT environment variable or dnacentersdk.config.DEFAULT_SINGLE_REQUEST_TIMEOUT if the environment variable is not set.

  • wait_on_rate_limit (bool) – Enables or disables automatic rate-limit handling. Defaults to the DNA_CENTER_WAIT_ON_RATE_LIMIT environment variable or dnacentersdk.config.DEFAULT_WAIT_ON_RATE_LIMIT if the environment variable is not set.

  • verify (bool,basestring) – Controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to the DNA_CENTER_VERIFY environment variable or dnacentersdk.config.DEFAULT_VERIFY if the environment variables are not set.

  • version (basestring) – Controls which version of DNA_CENTER to use. Defaults to the DNA_CENTER_VERSION environment variable or dnacentersdk.config.DEFAULT_VERSION if the environment variable is not set.

  • debug (bool,basestring) – Controls whether to log information about DNA Center APIs’ request and response process. Defaults to the DNA_CENTER_DEBUG environment variable or False if the environment variable is not set.

  • object_factory (callable) – The factory function to use to create Python objects from the returned DNA Center JSON data objects.

  • validator (callable) – The factory function to use to validate Python objects sent in the body of the request.

Returns:

A new DNACenterAPI object.

Return type:

DNACenterAPI

Raises:
  • TypeError – If the parameter types are incorrect.

  • AccessTokenError – If an access token is not provided via the access_token argument or an environment variable.

  • VersionError – If the version is not provided via the version argument or an environment variable, or it is not a DNA Center API supported version [‘1.2.10’, ‘1.3.0’, ‘1.3.1’, ‘1.3.3’, ‘2.1.1’, ‘2.1.2’, ‘2.2.1’, ‘2.2.2.3’, ‘2.2.3.3’, ‘2.3.3.0’, ‘2.3.5.3’].

property session

The DNA Center API session.

property access_token

The access token used for API calls to the DNA Center service.

property version

The API version of DNA Center.

property verify

The verify (TLS Certificate) for the API endpoints.

property base_url

The base URL prefixed to the individual API endpoint suffixes.

property single_request_timeout

Timeout (in seconds) for an single HTTP request.

property wait_on_rate_limit

Automatic rate-limit handling enabled / disabled.

authentication

class Authentication[source]

Cisco DNA Center Authentication API.

Wraps the DNA Center Authentication API and exposes the API as native Python methods that return native Python objects.

property verify

The verify (TLS Certificate) for the API endpoints.

property base_url

The base URL for the API endpoints.

property single_request_timeout

Timeout in seconds for the API requests.

authentication_api(username, password, encoded_auth=None)[source]

Exchange basic auth data for an Access Token(x-auth-token) that can be used to invoke the APIs.

Parameters:
  • username (basestring) – HTTP Basic Auth username.

  • password (basestring) – HTTP Basic Auth password.

  • encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.

Returns:

An AccessToken object with the access token provided by the DNA Center cloud.

Return type:

AccessToken

Raises:
  • TypeError – If the parameter types are incorrect.

  • ApiError – If the DNA Center cloud returns an error.

custom_caller

class CustomCaller[source]

Cisco DNA Center CustomCaller.

DNA Center CustomCaller allows API creation.

add_api(name, obj)[source]

Adds an api call to the CustomCaller.

Parameters:
  • name (str) – name you want to set to the api client, has to follow python variable naming rule.

  • obj (object) – api call which is actually a calling call_api method.

call_api(method, resource_path, raise_exception=True, original_response=False, **kwargs)[source]

Handles the requests and response.

Parameters:
  • method (basestring) – type of request.

  • resource_path (basestring) – URL in the request object.

  • raise_exception (bool) – If True, http exceptions will be raised.

  • original_response (bool) – If True, MyDict (JSON response) is returned, else response object.

  • path_params (dict) (optional) – Find each path_params’ key in the resource_path and replace it with path_params’ value.

  • params (optional) – Dictionary or bytes to be sent in the query string for the Request.

  • data (optional) – Dictionary, bytes, or file-like object to send in the body of the Request.

  • json (optional) – json data to send in the body of the Request.

  • headers (optional) – Dictionary of HTTP Headers to send with the Request.

  • cookies (optional) – Dict or CookieJar object to send with the Request.

  • files (optional) – Dictionary of ‘name’: file-like-objects (or {‘name’: (‘filename’, fileobj)}) for multipart encoding upload.

  • auth (optional) – Auth tuple to enable Basic/Digest/Custom HTTP Auth.

  • timeout (float, tuple) (optional) – How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.

  • allow_redirects (bool) (optional) – bool. Set to True if POST/PUT/DELETE redirect following is allowed.

  • proxies (optional) – Dictionary mapping protocol to the URL of the proxy.

  • verify (bool,string) (optional) – if True, the SSL cert will be verified. A CA_BUNDLE path can also be provided as a string.

  • stream (optional) – if False, the response content will be immediately downloaded.

  • cert (basestring, tuple) (optional) – if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair

Returns:

If original_response is True returns the original object response, else returns a JSON response with access to the object’s properties by using the dot notation or the bracket notation. Defaults to False.

Return type:

MyDict or object

Raises:
  • TypeError – If the parameter types are incorrect.

  • HTTPError – If the DNA Center cloud returns an error.

DNACenterAPI v1.2.10

clients

class Clients[source]

Cisco DNA Center Clients API (version: 1.2.10).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • mac_address (basestring) – MAC Address of the client.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 1.2.10).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs.

Parameters:
  • commands (list) – CommandRunnerDTO’s commands (list of strings).

  • description (string) – CommandRunnerDTO’s description.

  • deviceUuids (list) – CommandRunnerDTO’s deviceUuids (list of strings).

  • name (string) – CommandRunnerDTO’s name.

  • timeout (number) – CommandRunnerDTO’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 1.2.10).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id.

Parameters:
  • id (basestring) – Module UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, location name and a wide variety of additional criteria. You can also use the asterisk in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET fqdnoripofdnacenterplatform/dna/intent/api/v1/network- device? hostname=myhost* & managementIpAddress=192.25.18.* For a complete list of parameter names that you can use for filtering this request, see the DNA Center API Reference documentation. Note: If id parameter is provided, it will return the list of network-devices for the given ids and ignores the other request parameters. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – Accepts comma separated id’s and return list of network-devices for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs.

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – Vlan assocaited with sub-interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range.

Parameters:
  • device_id (basestring) – Device ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id.

Parameters:
  • id (basestring) – Device ID.

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID.

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name.

Parameters:
  • device_id (basestring) – Device ID.

  • name (basestring) – Interface name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id.

Parameters:
  • id (basestring) – Functional Capability UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router.

Parameters:
  • id (string) – NetworkDeviceBriefNIO’s id.

  • role (string) – NetworkDeviceBriefNIO’s role.

  • roleSource (string) – NetworkDeviceBriefNIO’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces by specified IP address.

Parameters:
  • ip_address (basestring) – IP address of the interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address.

Parameters:
  • ip_address (basestring) – Device IP address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=500, offset=1, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID.

Parameters:
  • id (basestring) – Interface ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices.

Parameters:
  • device_id (basestring) – Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification.

Parameters:
  • serial_number (basestring) – Serial number of the device.

  • macaddress (basestring) – Mac addres of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number.

Parameters:
  • serial_number (basestring) – Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file.

Parameters:
  • deviceUuids (list) – ExportDeviceDTO’s deviceUuids (list of strings).

  • id (string) – ExportDeviceDTO’s id.

  • operationEnum (string) – ExportDeviceDTO’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – ExportDeviceDTO’s parameters (list of strings).

  • password (string) – ExportDeviceDTO’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the device data is required.

  • search_by (basestring) – MAC Address or Device Name value or UUID of the network device.

  • identifier (basestring) – One of keywords : macAddress or uuid or nwDeviceName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

fabric_wired

class FabricWired[source]

Cisco DNA Center Fabric Wired API (version: 1.2.10).

Wraps the DNA Center Fabric Wired API and exposes the API as native Python methods that return native Python objects.

gets_border_device_detail(device_ip_address, sda_border_device, headers=None, **request_parameters)[source]

Beta - Gets border device detail from SDA Fabric.

Parameters:
  • sda_border_device (basestring) – sda/border-device path parameter.

  • device_ip_address (basestring) – device-ip-address path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(sda_border_device, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric.

Parameters:
  • sda_border_device (basestring) – sda/border-device path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_ip_address, sda_border_device, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric.

Parameters:
  • sda_border_device (basestring) – sda/border-device path parameter.

  • device_ip_address (basestring) – device-ip-address path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 1.2.10).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace.

Parameters:
  • name_space (basestring) – A listing of fileId’s.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId.

Parameters:
  • file_id (basestring) – File Identification number.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

network_discovery

class NetworkDiscovery[source]

Cisco DNA Center Network Discovery API (version: 1.2.10).

Wraps the DNA Center Network Discovery API and exposes the API as native Python methods that return native Python objects.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community.

Parameters:
  • comments (string) – SNMPv2WriteCommunityDTO’s comments.

  • credentialType (string) – SNMPv2WriteCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2WriteCommunityDTO’s description.

  • id (string) – SNMPv2WriteCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2WriteCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2WriteCommunityDTO’s instanceUuid.

  • writeCommunity (string) – SNMPv2WriteCommunityDTO’s writeCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential.

Parameters:
  • authPassword (string) – SNMPv3CredentialDTO’s authPassword.

  • authType (string) – SNMPv3CredentialDTO’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – SNMPv3CredentialDTO’s comments.

  • credentialType (string) – SNMPv3CredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv3CredentialDTO’s description.

  • id (string) – SNMPv3CredentialDTO’s id.

  • instanceTenantId (string) – SNMPv3CredentialDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv3CredentialDTO’s instanceUuid.

  • privacyPassword (string) – SNMPv3CredentialDTO’s privacyPassword.

  • privacyType (string) – SNMPv3CredentialDTO’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – SNMPv3CredentialDTO’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – SNMPv3CredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, noAddNewDevice=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, reDiscovery=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters.

Parameters:
  • cdpLevel (number) – InventoryRequest’s cdpLevel.

  • discoveryType (string) – InventoryRequest’s discoveryType.

  • enablePasswordList (list) – InventoryRequest’s enablePasswordList (list of string, objects).

  • globalCredentialIdList (list) – InventoryRequest’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – InventoryRequest’s httpReadCredential.

  • httpWriteCredential (object) – InventoryRequest’s httpWriteCredential.

  • ipAddressList (string) – InventoryRequest’s ipAddressList.

  • ipFilterList (list) – InventoryRequest’s ipFilterList (list of string, objects).

  • lldpLevel (number) – InventoryRequest’s lldpLevel.

  • name (string) – InventoryRequest’s name.

  • netconfPort (string) – InventoryRequest’s netconfPort.

  • noAddNewDevice (boolean) – InventoryRequest’s noAddNewDevice.

  • parentDiscoveryId (string) – InventoryRequest’s parentDiscoveryId.

  • passwordList (list) – InventoryRequest’s passwordList (list of string, objects).

  • preferredMgmtIPMethod (string) – InventoryRequest’s preferredMgmtIPMethod.

  • protocolOrder (string) – InventoryRequest’s protocolOrder.

  • reDiscovery (boolean) – InventoryRequest’s reDiscovery.

  • retry (number) – InventoryRequest’s retry.

  • snmpAuthPassphrase (string) – InventoryRequest’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryRequest’s snmpAuthProtocol.

  • snmpMode (string) – InventoryRequest’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryRequest’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryRequest’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryRequest’s snmpROCommunity.

  • snmpROCommunityDesc (string) – InventoryRequest’s snmpROCommunityDesc.

  • snmpRWCommunity (string) – InventoryRequest’s snmpRWCommunity.

  • snmpRWCommunityDesc (string) – InventoryRequest’s snmpRWCommunityDesc.

  • snmpUserName (string) – InventoryRequest’s snmpUserName.

  • snmpVersion (string) – InventoryRequest’s snmpVersion.

  • timeout (number) – InventoryRequest’s timeout.

  • updateMgmtIp (boolean) – InventoryRequest’s updateMgmtIp.

  • userNameList (list) – InventoryRequest’s userNameList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s).

Parameters:
  • siteUuids (list) – SitesInfoDTO’s siteUuids (list of strings).

  • global_credential_id (basestring) – Global credential Uuid.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery.

Parameters:
  • attributeInfo (object) – DiscoveryNIO’s attributeInfo.

  • cdpLevel (number) – DiscoveryNIO’s cdpLevel.

  • deviceIds (string) – DiscoveryNIO’s deviceIds.

  • discoveryCondition (string) – DiscoveryNIO’s discoveryCondition.

  • discoveryStatus (string) – DiscoveryNIO’s discoveryStatus.

  • discoveryType (string) – DiscoveryNIO’s discoveryType.

  • enablePasswordList (string) – DiscoveryNIO’s enablePasswordList.

  • globalCredentialIdList (list) – DiscoveryNIO’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – DiscoveryNIO’s httpReadCredential.

  • httpWriteCredential (object) – DiscoveryNIO’s httpWriteCredential.

  • id (string) – DiscoveryNIO’s id.

  • ipAddressList (string) – DiscoveryNIO’s ipAddressList.

  • ipFilterList (string) – DiscoveryNIO’s ipFilterList.

  • isAutoCdp (boolean) – DiscoveryNIO’s isAutoCdp.

  • lldpLevel (number) – DiscoveryNIO’s lldpLevel.

  • name (string) – DiscoveryNIO’s name.

  • netconfPort (string) – DiscoveryNIO’s netconfPort.

  • numDevices (number) – DiscoveryNIO’s numDevices.

  • parentDiscoveryId (string) – DiscoveryNIO’s parentDiscoveryId.

  • passwordList (string) – DiscoveryNIO’s passwordList.

  • preferredMgmtIPMethod (string) – DiscoveryNIO’s preferredMgmtIPMethod.

  • protocolOrder (string) – DiscoveryNIO’s protocolOrder.

  • retryCount (number) – DiscoveryNIO’s retryCount.

  • snmpAuthPassphrase (string) – DiscoveryNIO’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – DiscoveryNIO’s snmpAuthProtocol.

  • snmpMode (string) – DiscoveryNIO’s snmpMode.

  • snmpPrivPassphrase (string) – DiscoveryNIO’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – DiscoveryNIO’s snmpPrivProtocol.

  • snmpRoCommunity (string) – DiscoveryNIO’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – DiscoveryNIO’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – DiscoveryNIO’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – DiscoveryNIO’s snmpRwCommunityDesc.

  • snmpUserName (string) – DiscoveryNIO’s snmpUserName.

  • timeOut (number) – DiscoveryNIO’s timeOut.

  • updateMgmtIp (boolean) – DiscoveryNIO’s updateMgmtIp.

  • userNameList (string) – DiscoveryNIO’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community.

Parameters:
  • comments (string) – SNMPv2ReadCommunityDTO’s comments.

  • credentialType (string) – SNMPv2ReadCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2ReadCommunityDTO’s description.

  • id (string) – SNMPv2ReadCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2ReadCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2ReadCommunityDTO’s instanceUuid.

  • readCommunity (string) – SNMPv2ReadCommunityDTO’s readCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id.

Parameters:
  • id (basestring) – Global Credential ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials.

Parameters:
  • comments (string) – HTTPWriteCredentialDTO’s comments.

  • credentialType (string) – HTTPWriteCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPWriteCredentialDTO’s description.

  • id (string) – HTTPWriteCredentialDTO’s id.

  • instanceTenantId (string) – HTTPWriteCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPWriteCredentialDTO’s instanceUuid.

  • password (string) – HTTPWriteCredentialDTO’s password.

  • port (number) – HTTPWriteCredentialDTO’s port.

  • secure (boolean) – HTTPWriteCredentialDTO’s secure.

  • username (string) – HTTPWriteCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them.

Parameters:
  • start_index (int) – Start index.

  • records_to_delete (int) – Number of records to delete.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials.

Parameters:
  • comments (string) – NetconfCredentialDTO’s comments.

  • credentialType (string) – NetconfCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – NetconfCredentialDTO’s description.

  • id (string) – NetconfCredentialDTO’s id.

  • instanceTenantId (string) – NetconfCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – NetconfCredentialDTO’s instanceUuid.

  • netconfPort (string) – NetconfCredentialDTO’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID.

Parameters:
  • global_credential_id (basestring) – ID of global-credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential.

Parameters:
  • comments (string) – HTTPReadCredentialDTO’s comments.

  • credentialType (string) – HTTPReadCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPReadCredentialDTO’s description.

  • id (string) – HTTPReadCredentialDTO’s id.

  • instanceTenantId (string) – HTTPReadCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPReadCredentialDTO’s instanceUuid.

  • password (string) – HTTPReadCredentialDTO’s password.

  • port (number) – HTTPReadCredentialDTO’s port.

  • secure (boolean) – HTTPReadCredentialDTO’s secure.

  • username (string) – HTTPReadCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials.

Parameters:
  • comments (string) – CLICredentialDTO’s comments.

  • credentialType (string) – CLICredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – CLICredentialDTO’s description.

  • enablePassword (string) – CLICredentialDTO’s enablePassword.

  • id (string) – CLICredentialDTO’s id.

  • instanceTenantId (string) – CLICredentialDTO’s instanceTenantId.

  • instanceUuid (string) – CLICredentialDTO’s instanceUuid.

  • password (string) – CLICredentialDTO’s password.

  • username (string) – CLICredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type.

Parameters:
  • credential_sub_type (basestring) – Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF.

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

networks

class Networks[source]

Cisco DNA Center Networks API (version: 1.2.10).

Wraps the DNA Center Networks API and exposes the API as native Python methods that return native Python objects.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType.

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol.

Parameters:
  • topology_type (basestring) – Type of topology(OSPF,ISIS,etc).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID.

Parameters:
  • vlan_id (basestring) – Vlan Name for e.g Vlan1, Vlan23 etc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Network health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

non_fabric_wireless

class NonFabricWireless[source]

Cisco DNA Center Non-Fabric Wireless API (version: 1.2.10).

Wraps the DNA Center Non-Fabric Wireless API and exposes the API as native Python methods that return native Python objects.

delete_and_provision_ssid(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Beta - Removes SSID from the given site profile and provisions these changes to devices matching the site profile.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • managed_aplocations (basestring) – Enter complete site hierarchy to remove the SSID from the devices found in it. To enter more than one site hierarchy, use comma delimiter without extra space.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(enableBroadcastSSID=None, enableFastLane=None, enableMACFiltering=None, fastTransition=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Beta - Creates enterprise SSID.

Parameters:
  • enableBroadcastSSID (boolean) – enableBroadcastSSID, property of the request body.

  • enableFastLane (boolean) – enableFastLane, property of the request body.

  • enableMACFiltering (boolean) – enableMACFiltering, property of the request body.

  • fastTransition (string) – Fast Transition, property of the request body. Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • name (string) – Enter SSID Name, property of the request body. Constraints: maxLength set to 32.

  • passphrase (string) – Pass Phrase (Only applicable for SSID with PERSONAL security level), property of the request body. Constraints: maxLength set to 63 and minLength set to 8.

  • radioPolicy (string) – Radio Policy, property of the request body. Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Security Level, property of the request body. Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • trafficType (string) – Traffic Type, property of the request body. Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, vlanAndDynamicInterfaceDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Beta - Creates SSID, adds it to the corresponding site profiles and provisions to devices matching the site profile.

Parameters:
  • enableFabric (boolean) – enableFabric, property of the request body.

  • flexConnect (object) – Flex Connect Applicable for non fabric profile, property of the request body.

  • managedAPLocations (list) – Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body (list of strings).

  • ssidDetails (object) – SsidDetails, property of the request body.

  • ssidType (string) – SSID Type, property of the request body. Available values are ‘Guest’ and ‘Enterprise’.

  • vlanAndDynamicInterfaceDetails (object) – VLAN And Dynamic Interface Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Beta - Deletes given enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Beta - Gets either one or all the enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 1.2.10).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

Parameters:
  • periodic_refresh (bool) – Is analysis periodically refreshed?.

  • source_ip (basestring) – Source IP address.

  • dest_ip (basestring) – Destination IP adress.

  • source_port (basestring) – Source port.

  • dest_port (basestring) – Destination port.

  • gt_create_time (basestring) – Analyses requested after this time.

  • lt_create_time (basestring) – Analyses requested before this time.

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – Task ID.

  • last_update_time (basestring) – Last update time.

  • limit (basestring) – Number of resources returned.

  • offset (basestring) – Start index of resources returned (1-based).

  • order (basestring) – Order by this field.

  • sort_by (basestring) – Sort by this field.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

Parameters:
  • controlPath (boolean) – FlowAnalysisRequest’s controlPath.

  • destIP (string) – FlowAnalysisRequest’s destIP.

  • destPort (string) – FlowAnalysisRequest’s destPort.

  • inclusions (list) – FlowAnalysisRequest’s inclusions (list of strings).

  • periodicRefresh (boolean) – FlowAnalysisRequest’s periodicRefresh.

  • protocol (string) – FlowAnalysisRequest’s protocol.

  • sourceIP (string) – FlowAnalysisRequest’s sourceIP.

  • sourcePort (string) – FlowAnalysisRequest’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

pnp

class Pnp[source]

Cisco DNA Center PnP API (version: 1.2.10).

Wraps the DNA Center PnP API and exposes the API as native Python methods that return native Python objects.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow.

Parameters:
  • deviceIdList (list) – UnclaimRequest’s deviceIdList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count.

Parameters:
  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings.

Parameters:
  • _id (string) – Settings’s _id.

  • aaaCredentials (object) – Settings’s aaaCredentials.

  • acceptEula (boolean) – Settings’s acceptEula.

  • defaultProfile (object) – Settings’s defaultProfile.

  • savaMappingList (list) – Settings’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Settings’s taskTimeOuts.

  • tenantId (string) – Settings’s tenantId.

  • version (number) – Settings’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state.

Parameters:
  • deviceResetList (list) – ResetRequest’s deviceResetList (list of objects).

  • projectId (string) – ResetRequest’s projectId.

  • workflowId (string) – ResetRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated lost of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • type (basestring, list, set, tuple) – Workflow Type.

  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow.

Parameters:
  • configFileUrl (string) – ClaimDeviceRequest’s configFileUrl.

  • configId (string) – ClaimDeviceRequest’s configId.

  • deviceClaimList (list) – ClaimDeviceRequest’s deviceClaimList (list of objects).

  • fileServiceId (string) – ClaimDeviceRequest’s fileServiceId.

  • imageId (string) – ClaimDeviceRequest’s imageId.

  • imageUrl (string) – ClaimDeviceRequest’s imageUrl.

  • populateInventory (boolean) – ClaimDeviceRequest’s populateInventory.

  • projectId (string) – ClaimDeviceRequest’s projectId.

  • workflowId (string) – ClaimDeviceRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, last_contact=None, limit=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination.

Parameters:
  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter.

Parameters:
  • serial_number (basestring) – Device Serial Number.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

swim

class Swim[source]

Cisco DNA Center SWIM API (version: 1.2.10).

Wraps the DNA Center SWIM API and exposes the API as native Python methods that return native Python objects.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order='asc', version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%”.

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED.

  • version (basestring) – software Image Version.

  • image_series (basestring) – image Series.

  • image_name (basestring) – image Name.

  • is_tagged_golden (bool) – is Tagged Golden.

  • is_cco_recommended (bool) – is recommended from cisco.com.

  • is_cco_latest (bool) – is latest from cisco.com.

  • created_time (int) – time in milliseconds (epoch format).

  • image_size_greater_than (int) – size in bytes.

  • image_size_lesser_than (int) – size in bytes.

  • sort_by (basestring) – sort results by this field.

  • sort_order (basestring) – sort order ‘asc’ or ‘des’. Default is asc.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – Third party Image check.

  • third_party_vendor (basestring) – Third Party Vendor.

  • third_party_image_family (basestring) – Third Party image family.

  • third_party_application_type (basestring) – Third Party Application Type.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

Parameters:
  • schedule_at (basestring) – Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – Custom Description (Optional).

  • schedule_origin (basestring) – Originator of this call (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash.

Parameters:
  • schedule_validate (bool) – scheduleValidate, validates data before schedule (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_profile

class SiteProfile[source]

Cisco DNA Center Site Profile API (version: 1.2.10).

Wraps the DNA Center Site Profile API and exposes the API as native Python methods that return native Python objects.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Beta - Returns provisioning device information for the specified IP address.

Parameters:
  • device_ip (basestring) – Device to which the provisioning detail has to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_nfv(callbackUrl=None, provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor .

Parameters:
  • callbackUrl (string) – Callback Url, property of the request body.

  • provisioning (list) – Provisioning, property of the request body (list of objects).

  • siteProfile (list) – Site Profile, property of the request body (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 1.2.10).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Site Hierarchy data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • site_id (basestring) – Site id to which the device is assigned.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 1.2.10).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level='0', member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.

Parameters:
  • memberToTags (list) – TagMemberDTO’s memberToTags (list of objects).

  • memberType (string) – TagMemberDTO’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count.

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size in kilobytes(KB).

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_id (basestring) – TagMember id to be removed from tag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level='0', limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – Entity type of the member. Possible values can be retrieved by using /tag/member/type API.

  • offset (basestring) – Used for pagination. It indicates the starting row number out of available member records.

  • limit (basestring) – Used to Number of maximum members to return in the result.

  • member_association_type (basestring) – Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria.

Parameters:
  • name (basestring) – Tag name is mandatory when filter operation is used.

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size in kilobytes(KB).

  • field (basestring) – Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.

  • sort_by (basestring) – Only supported attribute is name. SortyBy is mandatory when order is used.

  • order (basestring) – Available values are asc and des.

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 1.2.10).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – Sort results by this field.

  • order (basestring) – Sort order asc or dsc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid.

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – Index, minimum value is 0.

  • limit (int) – The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

template_programmer

class TemplateProgrammer[source]

Cisco DNA Center Template Programmer API (version: 1.2.10).

Wraps the DNA Center Template Programmer API and exposes the API as native Python methods that return native Python objects.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, software_type=None, software_version=None, headers=None, **request_parameters)[source]

List the templates available.

Parameters:
  • project_id (basestring) – projectId query parameter.

  • software_type (basestring) – softwareType query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • product_family (basestring) – productFamily query parameter.

  • product_series (basestring) – productSeries query parameter.

  • product_type (basestring) – productType query parameter.

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, headers=None, **request_parameters)[source]

Returns the projects in the system.

Parameters:
  • name (basestring) – Name of project to be searched.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploys a template.

Parameters:
  • forcePushTemplate (boolean) – TemplateDeploymentInfo’s forcePushTemplate.

  • isComposite (boolean) – TemplateDeploymentInfo’s isComposite.

  • mainTemplateId (string) – TemplateDeploymentInfo’s mainTemplateId.

  • memberTemplateDeploymentInfo (list) – TemplateDeploymentInfo’s memberTemplateDeploymentInfo (list of any objects).

  • targetInfo (list) – TemplateDeploymentInfo’s targetInfo (list of objects).

  • templateId (string) – TemplateDeploymentInfo’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Returns details of the specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • latest_version (bool) – latestVersion query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

Returns the status of a deployed template.

Parameters:
  • deployment_id (basestring) – deploymentId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_template(template_id, headers=None, **request_parameters)[source]

Deletes an existing template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Versioning for the current contents of the template.

Parameters:
  • comments (string) – TemplateVersionRequestDTO’s comments.

  • templateId (string) – TemplateVersionRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(params=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Previews an existing template.

Parameters:
  • params (object) – TemplatePreviewRequestDTO’s params.

  • templateId (string) – TemplatePreviewRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_project(project_id, headers=None, **request_parameters)[source]

Deletes an existing Project.

Parameters:
  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Returns the versions of a specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v1.3.0

clients

class Clients[source]

Cisco DNA Center Clients API (version: 1.3.0).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • mac_address (basestring) – MAC Address of the client.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 1.3.0).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs.

Parameters:
  • commands (list) – CommandRunnerDTO’s commands (list of strings).

  • description (string) – CommandRunnerDTO’s description.

  • deviceUuids (list) – CommandRunnerDTO’s deviceUuids (list of strings).

  • name (string) – CommandRunnerDTO’s name.

  • timeout (number) – CommandRunnerDTO’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 1.3.0).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id.

Parameters:
  • id (basestring) – Device ID.

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, location name and a wide variety of additional criteria. You can also use the asterisk in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET fqdnoripofdnacenterplatform/dna/intent/api/v1/network- device? hostname=myhost* & managementIpAddress=192.25.18.* For a complete list of parameter names that you can use for filtering this request, see the DNA Center API Reference documentation. Note: If id parameter is provided, it will return the list of network-devices for the given ids and ignores the other request parameters. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – Accepts comma separated id’s and return list of network-devices for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs.

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – Vlan assocaited with sub-interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range.

Parameters:
  • device_id (basestring) – Device ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name.

Parameters:
  • device_id (basestring) – Device ID.

  • name (basestring) – Interface name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id.

Parameters:
  • id (basestring) – Functional Capability UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID.

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification.

Parameters:
  • serial_number (basestring) – Serial number of the device.

  • macaddress (basestring) – Mac addres of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router.

Parameters:
  • id (string) – NetworkDeviceBriefNIO’s id.

  • role (string) – NetworkDeviceBriefNIO’s role.

  • roleSource (string) – NetworkDeviceBriefNIO’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file.

Parameters:
  • deviceUuids (list) – ExportDeviceDTO’s deviceUuids (list of strings).

  • id (string) – ExportDeviceDTO’s id.

  • operationEnum (string) – ExportDeviceDTO’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – ExportDeviceDTO’s parameters (list of strings).

  • password (string) – ExportDeviceDTO’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces by specified IP address.

Parameters:
  • ip_address (basestring) – IP address of the interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address.

Parameters:
  • ip_address (basestring) – Device IP address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number.

Parameters:
  • serial_number (basestring) – Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID.

Parameters:
  • id (basestring) – Interface ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id=None, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices.

Parameters:
  • device_id (basestring) – Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the device data is required.

  • search_by (basestring) – MAC Address or Device Name value or UUID of the network device.

  • identifier (basestring) – One of keywords : macAddress or uuid or nwDeviceName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

fabric_wired

class FabricWired[source]

Cisco DNA Center Fabric Wired API (version: 1.3.0).

Wraps the DNA Center Fabric Wired API and exposes the API as native Python methods that return native Python objects.

deletes_border_device_from_sda_fabric(device_ip_address, headers=None, **request_parameters)[source]

Deletes border device from sda Fabric.

Parameters:
  • device_ip_address (basestring) – device-ip-address path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device_in_sda_fabric(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_details_from_sda_fabric(device_ip_address, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric.

Parameters:
  • device_ip_address (basestring) – device-ip-address path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 1.3.0).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace.

Parameters:
  • name_space (basestring) – A listing of fileId’s.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId.

Parameters:
  • file_id (basestring) – File Identification number.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

network_discovery

class NetworkDiscovery[source]

Cisco DNA Center Network Discovery API (version: 1.3.0).

Wraps the DNA Center Network Discovery API and exposes the API as native Python methods that return native Python objects.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community.

Parameters:
  • comments (string) – SNMPv2WriteCommunityDTO’s comments.

  • credentialType (string) – SNMPv2WriteCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2WriteCommunityDTO’s description.

  • id (string) – SNMPv2WriteCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2WriteCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2WriteCommunityDTO’s instanceUuid.

  • writeCommunity (string) – SNMPv2WriteCommunityDTO’s writeCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential.

Parameters:
  • authPassword (string) – SNMPv3CredentialDTO’s authPassword.

  • authType (string) – SNMPv3CredentialDTO’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – SNMPv3CredentialDTO’s comments.

  • credentialType (string) – SNMPv3CredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv3CredentialDTO’s description.

  • id (string) – SNMPv3CredentialDTO’s id.

  • instanceTenantId (string) – SNMPv3CredentialDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv3CredentialDTO’s instanceUuid.

  • privacyPassword (string) – SNMPv3CredentialDTO’s privacyPassword.

  • privacyType (string) – SNMPv3CredentialDTO’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – SNMPv3CredentialDTO’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – SNMPv3CredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community.

Parameters:
  • comments (string) – SNMPv2ReadCommunityDTO’s comments.

  • credentialType (string) – SNMPv2ReadCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2ReadCommunityDTO’s description.

  • id (string) – SNMPv2ReadCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2ReadCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2ReadCommunityDTO’s instanceUuid.

  • readCommunity (string) – SNMPv2ReadCommunityDTO’s readCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, noAddNewDevice=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, reDiscovery=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters.

Parameters:
  • cdpLevel (number) – InventoryRequest’s cdpLevel.

  • discoveryType (string) – InventoryRequest’s discoveryType.

  • enablePasswordList (list) – InventoryRequest’s enablePasswordList (list of string, objects).

  • globalCredentialIdList (list) – InventoryRequest’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – InventoryRequest’s httpReadCredential.

  • httpWriteCredential (object) – InventoryRequest’s httpWriteCredential.

  • ipAddressList (string) – InventoryRequest’s ipAddressList.

  • ipFilterList (list) – InventoryRequest’s ipFilterList (list of string, objects).

  • lldpLevel (number) – InventoryRequest’s lldpLevel.

  • name (string) – InventoryRequest’s name.

  • netconfPort (string) – InventoryRequest’s netconfPort.

  • noAddNewDevice (boolean) – InventoryRequest’s noAddNewDevice.

  • parentDiscoveryId (string) – InventoryRequest’s parentDiscoveryId.

  • passwordList (list) – InventoryRequest’s passwordList (list of string, objects).

  • preferredMgmtIPMethod (string) – InventoryRequest’s preferredMgmtIPMethod.

  • protocolOrder (string) – InventoryRequest’s protocolOrder.

  • reDiscovery (boolean) – InventoryRequest’s reDiscovery.

  • retry (number) – InventoryRequest’s retry.

  • snmpAuthPassphrase (string) – InventoryRequest’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryRequest’s snmpAuthProtocol.

  • snmpMode (string) – InventoryRequest’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryRequest’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryRequest’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryRequest’s snmpROCommunity.

  • snmpROCommunityDesc (string) – InventoryRequest’s snmpROCommunityDesc.

  • snmpRWCommunity (string) – InventoryRequest’s snmpRWCommunity.

  • snmpRWCommunityDesc (string) – InventoryRequest’s snmpRWCommunityDesc.

  • snmpUserName (string) – InventoryRequest’s snmpUserName.

  • snmpVersion (string) – InventoryRequest’s snmpVersion.

  • timeout (number) – InventoryRequest’s timeout.

  • updateMgmtIp (boolean) – InventoryRequest’s updateMgmtIp.

  • userNameList (list) – InventoryRequest’s userNameList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential.

Parameters:
  • comments (string) – HTTPReadCredentialDTO’s comments.

  • credentialType (string) – HTTPReadCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPReadCredentialDTO’s description.

  • id (string) – HTTPReadCredentialDTO’s id.

  • instanceTenantId (string) – HTTPReadCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPReadCredentialDTO’s instanceUuid.

  • password (string) – HTTPReadCredentialDTO’s password.

  • port (number) – HTTPReadCredentialDTO’s port.

  • secure (boolean) – HTTPReadCredentialDTO’s secure.

  • username (string) – HTTPReadCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery.

Parameters:
  • attributeInfo (object) – DiscoveryNIO’s attributeInfo.

  • cdpLevel (number) – DiscoveryNIO’s cdpLevel.

  • deviceIds (string) – DiscoveryNIO’s deviceIds.

  • discoveryCondition (string) – DiscoveryNIO’s discoveryCondition.

  • discoveryStatus (string) – DiscoveryNIO’s discoveryStatus.

  • discoveryType (string) – DiscoveryNIO’s discoveryType.

  • enablePasswordList (string) – DiscoveryNIO’s enablePasswordList.

  • globalCredentialIdList (list) – DiscoveryNIO’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – DiscoveryNIO’s httpReadCredential.

  • httpWriteCredential (object) – DiscoveryNIO’s httpWriteCredential.

  • id (string) – DiscoveryNIO’s id.

  • ipAddressList (string) – DiscoveryNIO’s ipAddressList.

  • ipFilterList (string) – DiscoveryNIO’s ipFilterList.

  • isAutoCdp (boolean) – DiscoveryNIO’s isAutoCdp.

  • lldpLevel (number) – DiscoveryNIO’s lldpLevel.

  • name (string) – DiscoveryNIO’s name.

  • netconfPort (string) – DiscoveryNIO’s netconfPort.

  • numDevices (number) – DiscoveryNIO’s numDevices.

  • parentDiscoveryId (string) – DiscoveryNIO’s parentDiscoveryId.

  • passwordList (string) – DiscoveryNIO’s passwordList.

  • preferredMgmtIPMethod (string) – DiscoveryNIO’s preferredMgmtIPMethod.

  • protocolOrder (string) – DiscoveryNIO’s protocolOrder.

  • retryCount (number) – DiscoveryNIO’s retryCount.

  • snmpAuthPassphrase (string) – DiscoveryNIO’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – DiscoveryNIO’s snmpAuthProtocol.

  • snmpMode (string) – DiscoveryNIO’s snmpMode.

  • snmpPrivPassphrase (string) – DiscoveryNIO’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – DiscoveryNIO’s snmpPrivProtocol.

  • snmpRoCommunity (string) – DiscoveryNIO’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – DiscoveryNIO’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – DiscoveryNIO’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – DiscoveryNIO’s snmpRwCommunityDesc.

  • snmpUserName (string) – DiscoveryNIO’s snmpUserName.

  • timeOut (number) – DiscoveryNIO’s timeOut.

  • updateMgmtIp (boolean) – DiscoveryNIO’s updateMgmtIp.

  • userNameList (string) – DiscoveryNIO’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials.

Parameters:
  • comments (string) – HTTPWriteCredentialDTO’s comments.

  • credentialType (string) – HTTPWriteCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPWriteCredentialDTO’s description.

  • id (string) – HTTPWriteCredentialDTO’s id.

  • instanceTenantId (string) – HTTPWriteCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPWriteCredentialDTO’s instanceUuid.

  • password (string) – HTTPWriteCredentialDTO’s password.

  • port (number) – HTTPWriteCredentialDTO’s port.

  • secure (boolean) – HTTPWriteCredentialDTO’s secure.

  • username (string) – HTTPWriteCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them.

Parameters:
  • start_index (int) – Start index.

  • records_to_delete (int) – Number of records to delete.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID.

Parameters:
  • global_credential_id (basestring) – ID of global-credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials.

Parameters:
  • comments (string) – CLICredentialDTO’s comments.

  • credentialType (string) – CLICredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – CLICredentialDTO’s description.

  • enablePassword (string) – CLICredentialDTO’s enablePassword.

  • id (string) – CLICredentialDTO’s id.

  • instanceTenantId (string) – CLICredentialDTO’s instanceTenantId.

  • instanceUuid (string) – CLICredentialDTO’s instanceUuid.

  • password (string) – CLICredentialDTO’s password.

  • username (string) – CLICredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials.

Parameters:
  • comments (string) – NetconfCredentialDTO’s comments.

  • credentialType (string) – NetconfCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – NetconfCredentialDTO’s description.

  • id (string) – NetconfCredentialDTO’s id.

  • instanceTenantId (string) – NetconfCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – NetconfCredentialDTO’s instanceUuid.

  • netconfPort (string) – NetconfCredentialDTO’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id.

Parameters:
  • id (basestring) – Global Credential ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s).

Parameters:
  • siteUuids (list) – SitesInfoDTO’s siteUuids (list of strings).

  • global_credential_id (basestring) – Global credential Uuid.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type.

Parameters:
  • credential_sub_type (basestring) – Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF.

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

networks

class Networks[source]

Cisco DNA Center Networks API (version: 1.3.0).

Wraps the DNA Center Networks API and exposes the API as native Python methods that return native Python objects.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType.

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID.

Parameters:
  • vlan_id (basestring) – Vlan Name for e.g Vlan1, Vlan23 etc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol.

Parameters:
  • topology_type (basestring) – Type of topology(OSPF,ISIS,etc).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Network health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

non_fabric_wireless

class NonFabricWireless[source]

Cisco DNA Center Non-Fabric Wireless API (version: 1.3.0).

Wraps the DNA Center Non-Fabric Wireless API and exposes the API as native Python methods that return native Python objects.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile.

Parameters:
  • profile_name (basestring) – profileName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided.

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites.

Parameters:
  • enableFabric (boolean) – enableFabric, property of the request body.

  • flexConnect (object) – Flex Connect Applicable for non fabric profile, property of the request body.

  • managedAPLocations (list) – Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body (list of strings).

  • ssidDetails (object) – SsidDetails, property of the request body.

  • ssidType (string) – SSID Type, property of the request body. Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_and_provision_ssid(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID for the given site hierarchy matching network profile, provision the device and deletes the SSID from DNA Center.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • managed_aplocations (basestring) – Enter complete site hierarchy to remove the SSID from the devices found in it. To enter more than one site hierarchy, use comma delimiter without extra space.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(enableBroadcastSSID=None, enableFastLane=None, enableMACFiltering=None, fastTransition=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID.

Parameters:
  • enableBroadcastSSID (boolean) – enableBroadcastSSID, property of the request body.

  • enableFastLane (boolean) – enableFastLane, property of the request body.

  • enableMACFiltering (boolean) – enableMACFiltering, property of the request body.

  • fastTransition (string) – Fast Transition, property of the request body. Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • name (string) – Enter SSID Name, property of the request body. Constraints: maxLength set to 32.

  • passphrase (string) – Pass Phrase (Only applicable for SSID with PERSONAL security level), property of the request body. Constraints: maxLength set to 63 and minLength set to 8.

  • radioPolicy (string) – Radio Policy, property of the request body. Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Security Level, property of the request body. Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • trafficType (string) – Traffic Type, property of the request body. Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 1.3.0).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

Parameters:
  • periodic_refresh (bool) – Is analysis periodically refreshed?.

  • source_ip (basestring) – Source IP address.

  • dest_ip (basestring) – Destination IP adress.

  • source_port (basestring) – Source port.

  • dest_port (basestring) – Destination port.

  • gt_create_time (basestring) – Analyses requested after this time.

  • lt_create_time (basestring) – Analyses requested before this time.

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – Task ID.

  • last_update_time (basestring) – Last update time.

  • limit (basestring) – Number of resources returned.

  • offset (basestring) – Start index of resources returned (1-based).

  • order (basestring) – Order by this field.

  • sort_by (basestring) – Sort by this field.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

Parameters:
  • controlPath (boolean) – FlowAnalysisRequest’s controlPath.

  • destIP (string) – FlowAnalysisRequest’s destIP.

  • destPort (string) – FlowAnalysisRequest’s destPort.

  • inclusions (list) – FlowAnalysisRequest’s inclusions (list of strings).

  • periodicRefresh (boolean) – FlowAnalysisRequest’s periodicRefresh.

  • protocol (string) – FlowAnalysisRequest’s protocol.

  • sourceIP (string) – FlowAnalysisRequest’s sourceIP.

  • sourcePort (string) – FlowAnalysisRequest’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

pnp

class Pnp[source]

Cisco DNA Center PnP API (version: 1.3.0).

Wraps the DNA Center PnP API and exposes the API as native Python methods that return native Python objects.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow.

Parameters:
  • deviceIdList (list) – UnclaimRequest’s deviceIdList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count.

Parameters:
  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings.

Parameters:
  • _id (string) – Settings’s _id.

  • aaaCredentials (object) – Settings’s aaaCredentials.

  • acceptEula (boolean) – Settings’s acceptEula.

  • defaultProfile (object) – Settings’s defaultProfile.

  • savaMappingList (list) – Settings’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Settings’s taskTimeOuts.

  • tenantId (string) – Settings’s tenantId.

  • version (number) – Settings’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state.

Parameters:
  • deviceResetList (list) – ResetRequest’s deviceResetList (list of objects).

  • projectId (string) – ResetRequest’s projectId.

  • workflowId (string) – ResetRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated lost of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • type (basestring, list, set, tuple) – Workflow Type.

  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination.

Parameters:
  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter.

Parameters:
  • serial_number (basestring) – Device Serial Number.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, last_contact=None, limit=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow.

Parameters:
  • configFileUrl (string) – ClaimDeviceRequest’s configFileUrl.

  • configId (string) – ClaimDeviceRequest’s configId.

  • deviceClaimList (list) – ClaimDeviceRequest’s deviceClaimList (list of objects).

  • fileServiceId (string) – ClaimDeviceRequest’s fileServiceId.

  • imageId (string) – ClaimDeviceRequest’s imageId.

  • imageUrl (string) – ClaimDeviceRequest’s imageUrl.

  • populateInventory (boolean) – ClaimDeviceRequest’s populateInventory.

  • projectId (string) – ClaimDeviceRequest’s projectId.

  • workflowId (string) – ClaimDeviceRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

swim

class Swim[source]

Cisco DNA Center SWIM API (version: 1.3.0).

Wraps the DNA Center SWIM API and exposes the API as native Python methods that return native Python objects.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order='asc', version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%”.

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED.

  • version (basestring) – software Image Version.

  • image_series (basestring) – image Series.

  • image_name (basestring) – image Name.

  • is_tagged_golden (bool) – is Tagged Golden.

  • is_cco_recommended (bool) – is recommended from cisco.com.

  • is_cco_latest (bool) – is latest from cisco.com.

  • created_time (int) – time in milliseconds (epoch format).

  • image_size_greater_than (int) – size in bytes.

  • image_size_lesser_than (int) – size in bytes.

  • sort_by (basestring) – sort results by this field.

  • sort_order (basestring) – sort order ‘asc’ or ‘des’. Default is asc.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – Third party Image check.

  • third_party_vendor (basestring) – Third Party Vendor.

  • third_party_image_family (basestring) – Third Party image family.

  • third_party_application_type (basestring) – Third Party Application Type.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash.

Parameters:
  • schedule_validate (bool) – scheduleValidate, validates data before schedule (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

Parameters:
  • schedule_at (basestring) – Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – Custom Description (Optional).

  • schedule_origin (basestring) – Originator of this call (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_profile

class SiteProfile[source]

Cisco DNA Center Site Profile API (version: 1.3.0).

Wraps the DNA Center Site Profile API and exposes the API as native Python methods that return native Python objects.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address.

Parameters:
  • device_ip (basestring) – Device to which the provisioning detail has to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor .

Parameters:
  • provisioning (list) – Provisioning, property of the request body (list of objects).

  • siteProfile (list) – Site Profile, property of the request body (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information.

Parameters:
  • device_ip (string) – Device Ip, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 1.3.0).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Site Hierarchy data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site with area/building/floor with specified hierarchy.

Parameters:
  • name (basestring) – groupNameHierarchy (ex: global/groupName).

  • site_id (basestring) – site id.

  • type (basestring) – type (ex: area, building, floor).

  • offset (int) – offset/starting row.

  • limit (int) – Number of sites to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId.

Parameters:
  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • site_id (basestring) – Site id to which the device is assigned.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_membership(site_id, headers=None, **request_parameters)[source]

Getting the site children details and device details.

Parameters:
  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 1.3.0).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level='0', member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.

Parameters:
  • memberToTags (list) – TagMemberDTO’s memberToTags (list of objects).

  • memberType (string) – TagMemberDTO’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count.

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size in kilobytes(KB).

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level='0', limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – Entity type of the member. Possible values can be retrieved by using /tag/member/type API.

  • offset (basestring) – Used for pagination. It indicates the starting row number out of available member records.

  • limit (basestring) – Used to Number of maximum members to return in the result.

  • member_association_type (basestring) – Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_id (basestring) – TagMember id to be removed from tag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria.

Parameters:
  • name (basestring) – Tag name is mandatory when filter operation is used.

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size in kilobytes(KB).

  • field (basestring) – Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.

  • sort_by (basestring) – Only supported attribute is name. SortyBy is mandatory when order is used.

  • order (basestring) – Available values are asc and des.

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 1.3.0).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – Sort results by this field.

  • order (basestring) – Sort order asc or dsc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid.

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – Index, minimum value is 0.

  • limit (int) – The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

template_programmer

class TemplateProgrammer[source]

Cisco DNA Center Template Programmer API (version: 1.3.0).

Wraps the DNA Center Template Programmer API and exposes the API as native Python methods that return native Python objects.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, software_type=None, software_version=None, headers=None, **request_parameters)[source]

List the templates available.

Parameters:
  • project_id (basestring) – projectId query parameter.

  • software_type (basestring) – softwareType query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • product_family (basestring) – productFamily query parameter.

  • product_series (basestring) – productSeries query parameter.

  • product_type (basestring) – productType query parameter.

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, headers=None, **request_parameters)[source]

Returns the projects in the system.

Parameters:
  • name (basestring) – Name of project to be searched.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploys a template.

Parameters:
  • forcePushTemplate (boolean) – TemplateDeploymentInfo’s forcePushTemplate.

  • isComposite (boolean) – TemplateDeploymentInfo’s isComposite.

  • mainTemplateId (string) – TemplateDeploymentInfo’s mainTemplateId.

  • memberTemplateDeploymentInfo (list) – TemplateDeploymentInfo’s memberTemplateDeploymentInfo (list of any objects).

  • targetInfo (list) – TemplateDeploymentInfo’s targetInfo (list of objects).

  • templateId (string) – TemplateDeploymentInfo’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_template(template_id, headers=None, **request_parameters)[source]

Deletes an existing template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(params=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Previews an existing template.

Parameters:
  • params (object) – TemplatePreviewRequestDTO’s params.

  • templateId (string) – TemplatePreviewRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Returns the versions of a specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Versioning for the current contents of the template.

Parameters:
  • comments (string) – TemplateVersionRequestDTO’s comments.

  • templateId (string) – TemplateVersionRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Returns details of the specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • latest_version (bool) – latestVersion query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

Returns the status of a deployed template.

Parameters:
  • deployment_id (basestring) – deploymentId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_project(project_id, headers=None, **request_parameters)[source]

Deletes an existing Project.

Parameters:
  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v1.3.1

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 1.3.1).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id.

Parameters:
  • id (basestring) – Application’s Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id.

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name.

Parameters:
  • offset (int) – The offset of the first application to be returned.

  • limit (int) – The maximum number of applications to be returned.

  • name (basestring) – Application’s name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 1.3.1).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • mac_address (basestring) – MAC Address of the client.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 1.3.1).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs.

Parameters:
  • commands (list) – CommandRunnerDTO’s commands (list of strings).

  • description (string) – CommandRunnerDTO’s description.

  • deviceUuids (list) – CommandRunnerDTO’s deviceUuids (list of strings).

  • name (string) – CommandRunnerDTO’s name.

  • timeout (number) – CommandRunnerDTO’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 1.3.1).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, software_type=None, software_version=None, headers=None, **request_parameters)[source]

List the templates available.

Parameters:
  • project_id (basestring) – projectId query parameter.

  • software_type (basestring) – softwareType query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • product_family (basestring) – productFamily query parameter.

  • product_series (basestring) – productSeries query parameter.

  • product_type (basestring) – productType query parameter.

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, headers=None, **request_parameters)[source]

Returns the projects in the system.

Parameters:
  • name (basestring) – Name of project to be searched.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Versioning for the current contents of the template.

Parameters:
  • comments (string) – TemplateVersionRequestDTO’s comments.

  • templateId (string) – TemplateVersionRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploys a template.

Parameters:
  • forcePushTemplate (boolean) – TemplateDeploymentInfo’s forcePushTemplate.

  • isComposite (boolean) – TemplateDeploymentInfo’s isComposite.

  • mainTemplateId (string) – TemplateDeploymentInfo’s mainTemplateId.

  • memberTemplateDeploymentInfo (list) – TemplateDeploymentInfo’s memberTemplateDeploymentInfo (list of any objects).

  • targetInfo (list) – TemplateDeploymentInfo’s targetInfo (list of objects).

  • templateId (string) – TemplateDeploymentInfo’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Returns details of the specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • latest_version (bool) – latestVersion query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

Returns the status of a deployed template.

Parameters:
  • deployment_id (basestring) – deploymentId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_template(template_id, headers=None, **request_parameters)[source]

Deletes an existing template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Returns the versions of a specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_project(project_id, headers=None, **request_parameters)[source]

Deletes an existing Project.

Parameters:
  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(params=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Previews an existing template.

Parameters:
  • params (object) – TemplatePreviewRequestDTO’s params.

  • templateId (string) – TemplatePreviewRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 1.3.1).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow.

Parameters:
  • deviceIdList (list) – UnclaimRequest’s deviceIdList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count.

Parameters:
  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state.

Parameters:
  • deviceResetList (list) – ResetRequest’s deviceResetList (list of objects).

  • projectId (string) – ResetRequest’s projectId.

  • workflowId (string) – ResetRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated lost of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • type (basestring, list, set, tuple) – Workflow Type.

  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination.

Parameters:
  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter.

Parameters:
  • serial_number (basestring) – Device Serial Number.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings.

Parameters:
  • _id (string) – Settings’s _id.

  • aaaCredentials (object) – Settings’s aaaCredentials.

  • acceptEula (boolean) – Settings’s acceptEula.

  • defaultProfile (object) – Settings’s defaultProfile.

  • savaMappingList (list) – Settings’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Settings’s taskTimeOuts.

  • tenantId (string) – Settings’s tenantId.

  • version (number) – Settings’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow.

Parameters:
  • configFileUrl (string) – ClaimDeviceRequest’s configFileUrl.

  • configId (string) – ClaimDeviceRequest’s configId.

  • deviceClaimList (list) – ClaimDeviceRequest’s deviceClaimList (list of objects).

  • fileServiceId (string) – ClaimDeviceRequest’s fileServiceId.

  • imageId (string) – ClaimDeviceRequest’s imageId.

  • imageUrl (string) – ClaimDeviceRequest’s imageUrl.

  • populateInventory (boolean) – ClaimDeviceRequest’s populateInventory.

  • projectId (string) – ClaimDeviceRequest’s projectId.

  • workflowId (string) – ClaimDeviceRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, last_contact=None, limit=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 1.3.1).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, location name and a wide variety of additional criteria. You can also use the asterisk in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET fqdnoripofdnacenterplatform/dna/intent/api/v1/network- device? hostname=myhost* & managementIpAddress=192.25.18.* For a complete list of parameter names that you can use for filtering this request, see the DNA Center API Reference documentation. Note: If id parameter is provided, it will return the list of network-devices for the given ids and ignores the other request parameters. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – Accepts comma separated id’s and return list of network-devices for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id.

Parameters:
  • id (basestring) – Device ID.

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs.

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – Vlan assocaited with sub-interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range.

Parameters:
  • device_id (basestring) – Device ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name.

Parameters:
  • device_id (basestring) – Device ID.

  • name (basestring) – Interface name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id.

Parameters:
  • id (basestring) – Functional Capability UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID.

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID.

Parameters:
  • id (basestring) – Interface ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices.

Parameters:
  • device_id (basestring) – Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces by specified IP address.

Parameters:
  • ip_address (basestring) – IP address of the interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address.

Parameters:
  • ip_address (basestring) – Device IP address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number.

Parameters:
  • serial_number (basestring) – Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router.

Parameters:
  • id (string) – NetworkDeviceBriefNIO’s id.

  • role (string) – NetworkDeviceBriefNIO’s role.

  • roleSource (string) – NetworkDeviceBriefNIO’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file.

Parameters:
  • deviceUuids (list) – ExportDeviceDTO’s deviceUuids (list of strings).

  • id (string) – ExportDeviceDTO’s id.

  • operationEnum (string) – ExportDeviceDTO’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – ExportDeviceDTO’s parameters (list of strings).

  • password (string) – ExportDeviceDTO’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the device data is required.

  • search_by (basestring) – MAC Address or Device Name value or UUID of the network device.

  • identifier (basestring) – One of keywords : macAddress or uuid or nwDeviceName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification.

Parameters:
  • serial_number (basestring) – Serial number of the device.

  • macaddress (basestring) – Mac addres of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=500, offset=1, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 1.3.1).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=' ', limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • offset (int) – The number of Registries to offset in the resultset whose default value 0.

  • limit (int) – The number of Registries to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions.

Parameters:
  • subscriptions (basestring) – List of EventSubscriptionId’s for removal.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=20, offset=None, order=None, severity=None, sort_by=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • offset (int) – Offset whose default value 0.

  • limit (int) – Limit whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter.

Parameters:
  • execution_id (basestring) – Execution ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • offset (int) – The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

fabric_wired

class FabricWired[source]

Cisco DNA Center Fabric Wired API (version: 1.3.1).

Wraps the DNA Center Fabric Wired API and exposes the API as native Python methods that return native Python objects.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete default authentication profile from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile template in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_ipaddress, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_ipaddress, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 1.3.1).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace.

Parameters:
  • name_space (basestring) – A listing of fileId’s.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId.

Parameters:
  • file_id (basestring) – File Identification number.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 1.3.1).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_discovery

class NetworkDiscovery[source]

Cisco DNA Center Network Discovery API (version: 1.3.1).

Wraps the DNA Center Network Discovery API and exposes the API as native Python methods that return native Python objects.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community.

Parameters:
  • comments (string) – SNMPv2WriteCommunityDTO’s comments.

  • credentialType (string) – SNMPv2WriteCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2WriteCommunityDTO’s description.

  • id (string) – SNMPv2WriteCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2WriteCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2WriteCommunityDTO’s instanceUuid.

  • writeCommunity (string) – SNMPv2WriteCommunityDTO’s writeCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential.

Parameters:
  • authPassword (string) – SNMPv3CredentialDTO’s authPassword.

  • authType (string) – SNMPv3CredentialDTO’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – SNMPv3CredentialDTO’s comments.

  • credentialType (string) – SNMPv3CredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv3CredentialDTO’s description.

  • id (string) – SNMPv3CredentialDTO’s id.

  • instanceTenantId (string) – SNMPv3CredentialDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv3CredentialDTO’s instanceUuid.

  • privacyPassword (string) – SNMPv3CredentialDTO’s privacyPassword.

  • privacyType (string) – SNMPv3CredentialDTO’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – SNMPv3CredentialDTO’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – SNMPv3CredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community.

Parameters:
  • comments (string) – SNMPv2ReadCommunityDTO’s comments.

  • credentialType (string) – SNMPv2ReadCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2ReadCommunityDTO’s description.

  • id (string) – SNMPv2ReadCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2ReadCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2ReadCommunityDTO’s instanceUuid.

  • readCommunity (string) – SNMPv2ReadCommunityDTO’s readCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id.

Parameters:
  • id (basestring) – Global Credential ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, noAddNewDevice=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, reDiscovery=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters.

Parameters:
  • cdpLevel (number) – InventoryRequest’s cdpLevel.

  • discoveryType (string) – InventoryRequest’s discoveryType.

  • enablePasswordList (list) – InventoryRequest’s enablePasswordList (list of string, objects).

  • globalCredentialIdList (list) – InventoryRequest’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – InventoryRequest’s httpReadCredential.

  • httpWriteCredential (object) – InventoryRequest’s httpWriteCredential.

  • ipAddressList (string) – InventoryRequest’s ipAddressList.

  • ipFilterList (list) – InventoryRequest’s ipFilterList (list of string, objects).

  • lldpLevel (number) – InventoryRequest’s lldpLevel.

  • name (string) – InventoryRequest’s name.

  • netconfPort (string) – InventoryRequest’s netconfPort.

  • noAddNewDevice (boolean) – InventoryRequest’s noAddNewDevice.

  • parentDiscoveryId (string) – InventoryRequest’s parentDiscoveryId.

  • passwordList (list) – InventoryRequest’s passwordList (list of string, objects).

  • preferredMgmtIPMethod (string) – InventoryRequest’s preferredMgmtIPMethod.

  • protocolOrder (string) – InventoryRequest’s protocolOrder.

  • reDiscovery (boolean) – InventoryRequest’s reDiscovery.

  • retry (number) – InventoryRequest’s retry.

  • snmpAuthPassphrase (string) – InventoryRequest’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryRequest’s snmpAuthProtocol.

  • snmpMode (string) – InventoryRequest’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryRequest’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryRequest’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryRequest’s snmpROCommunity.

  • snmpROCommunityDesc (string) – InventoryRequest’s snmpROCommunityDesc.

  • snmpRWCommunity (string) – InventoryRequest’s snmpRWCommunity.

  • snmpRWCommunityDesc (string) – InventoryRequest’s snmpRWCommunityDesc.

  • snmpUserName (string) – InventoryRequest’s snmpUserName.

  • snmpVersion (string) – InventoryRequest’s snmpVersion.

  • timeout (number) – InventoryRequest’s timeout.

  • updateMgmtIp (boolean) – InventoryRequest’s updateMgmtIp.

  • userNameList (list) – InventoryRequest’s userNameList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s).

Parameters:
  • siteUuids (list) – SitesInfoDTO’s siteUuids (list of strings).

  • global_credential_id (basestring) – Global credential Uuid.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential.

Parameters:
  • comments (string) – HTTPReadCredentialDTO’s comments.

  • credentialType (string) – HTTPReadCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPReadCredentialDTO’s description.

  • id (string) – HTTPReadCredentialDTO’s id.

  • instanceTenantId (string) – HTTPReadCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPReadCredentialDTO’s instanceUuid.

  • password (string) – HTTPReadCredentialDTO’s password.

  • port (number) – HTTPReadCredentialDTO’s port.

  • secure (boolean) – HTTPReadCredentialDTO’s secure.

  • username (string) – HTTPReadCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery.

Parameters:
  • attributeInfo (object) – DiscoveryNIO’s attributeInfo.

  • cdpLevel (number) – DiscoveryNIO’s cdpLevel.

  • deviceIds (string) – DiscoveryNIO’s deviceIds.

  • discoveryCondition (string) – DiscoveryNIO’s discoveryCondition.

  • discoveryStatus (string) – DiscoveryNIO’s discoveryStatus.

  • discoveryType (string) – DiscoveryNIO’s discoveryType.

  • enablePasswordList (string) – DiscoveryNIO’s enablePasswordList.

  • globalCredentialIdList (list) – DiscoveryNIO’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – DiscoveryNIO’s httpReadCredential.

  • httpWriteCredential (object) – DiscoveryNIO’s httpWriteCredential.

  • id (string) – DiscoveryNIO’s id.

  • ipAddressList (string) – DiscoveryNIO’s ipAddressList.

  • ipFilterList (string) – DiscoveryNIO’s ipFilterList.

  • isAutoCdp (boolean) – DiscoveryNIO’s isAutoCdp.

  • lldpLevel (number) – DiscoveryNIO’s lldpLevel.

  • name (string) – DiscoveryNIO’s name.

  • netconfPort (string) – DiscoveryNIO’s netconfPort.

  • numDevices (number) – DiscoveryNIO’s numDevices.

  • parentDiscoveryId (string) – DiscoveryNIO’s parentDiscoveryId.

  • passwordList (string) – DiscoveryNIO’s passwordList.

  • preferredMgmtIPMethod (string) – DiscoveryNIO’s preferredMgmtIPMethod.

  • protocolOrder (string) – DiscoveryNIO’s protocolOrder.

  • retryCount (number) – DiscoveryNIO’s retryCount.

  • snmpAuthPassphrase (string) – DiscoveryNIO’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – DiscoveryNIO’s snmpAuthProtocol.

  • snmpMode (string) – DiscoveryNIO’s snmpMode.

  • snmpPrivPassphrase (string) – DiscoveryNIO’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – DiscoveryNIO’s snmpPrivProtocol.

  • snmpRoCommunity (string) – DiscoveryNIO’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – DiscoveryNIO’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – DiscoveryNIO’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – DiscoveryNIO’s snmpRwCommunityDesc.

  • snmpUserName (string) – DiscoveryNIO’s snmpUserName.

  • timeOut (number) – DiscoveryNIO’s timeOut.

  • updateMgmtIp (boolean) – DiscoveryNIO’s updateMgmtIp.

  • userNameList (string) – DiscoveryNIO’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials.

Parameters:
  • comments (string) – HTTPWriteCredentialDTO’s comments.

  • credentialType (string) – HTTPWriteCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPWriteCredentialDTO’s description.

  • id (string) – HTTPWriteCredentialDTO’s id.

  • instanceTenantId (string) – HTTPWriteCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPWriteCredentialDTO’s instanceUuid.

  • password (string) – HTTPWriteCredentialDTO’s password.

  • port (number) – HTTPWriteCredentialDTO’s port.

  • secure (boolean) – HTTPWriteCredentialDTO’s secure.

  • username (string) – HTTPWriteCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials.

Parameters:
  • comments (string) – CLICredentialDTO’s comments.

  • credentialType (string) – CLICredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – CLICredentialDTO’s description.

  • enablePassword (string) – CLICredentialDTO’s enablePassword.

  • id (string) – CLICredentialDTO’s id.

  • instanceTenantId (string) – CLICredentialDTO’s instanceTenantId.

  • instanceUuid (string) – CLICredentialDTO’s instanceUuid.

  • password (string) – CLICredentialDTO’s password.

  • username (string) – CLICredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials.

Parameters:
  • comments (string) – NetconfCredentialDTO’s comments.

  • credentialType (string) – NetconfCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – NetconfCredentialDTO’s description.

  • id (string) – NetconfCredentialDTO’s id.

  • instanceTenantId (string) – NetconfCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – NetconfCredentialDTO’s instanceUuid.

  • netconfPort (string) – NetconfCredentialDTO’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID.

Parameters:
  • global_credential_id (basestring) – ID of global-credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them.

Parameters:
  • start_index (int) – Start index.

  • records_to_delete (int) – Number of records to delete.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type.

Parameters:
  • credential_sub_type (basestring) – Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF.

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 1.3.1).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details.

Parameters:
  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_pool(headers=None, **request_parameters)[source]

API to get global pool.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential.

Parameters:
  • id (basestring) – global credential id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS).

Parameters:
  • sp_profile_name (basestring) – sp profile name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS).

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool.

Parameters:
  • id (basestring) – global pool id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

non_fabric_wireless

class NonFabricWireless[source]

Cisco DNA Center Non-Fabric Wireless API (version: 1.3.1).

Wraps the DNA Center Non-Fabric Wireless API and exposes the API as native Python methods that return native Python objects.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles.

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites.

Parameters:
  • enableFabric (boolean) – enableFabric, property of the request body.

  • flexConnect (object) – Flex Connect Applicable for non fabric profile, property of the request body.

  • managedAPLocations (list) – Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body (list of strings).

  • ssidDetails (object) – SsidDetails, property of the request body.

  • ssidType (string) – SSID Type, property of the request body. Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s).

Parameters:
  • rf_profile_name (basestring) – rf-profile-name path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile.

Parameters:
  • profile_name (basestring) – profileName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center.

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(enableBroadcastSSID=None, enableFastLane=None, enableMACFiltering=None, fastTransition=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID.

Parameters:
  • enableBroadcastSSID (boolean) – enableBroadcastSSID, property of the request body.

  • enableFastLane (boolean) – enableFastLane, property of the request body.

  • enableMACFiltering (boolean) – enableMACFiltering, property of the request body.

  • fastTransition (string) – Fast Transition, property of the request body. Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • name (string) – Enter SSID Name, property of the request body. Constraints: maxLength set to 32.

  • passphrase (string) – Pass Phrase (Only applicable for SSID with PERSONAL security level), property of the request body. Constraints: maxLength set to 63 and minLength set to 8.

  • radioPolicy (string) – Radio Policy, property of the request body. Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Security Level, property of the request body. Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • trafficType (string) – Traffic Type, property of the request body. Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided.

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile.

Parameters:
  • channelWidth (string) – Channel Width, property of the request body.

  • defaultRfProfile (boolean) – defaultRfProfile, property of the request body.

  • enableBrownField (boolean) – enableBrownField, property of the request body.

  • enableCustom (boolean) – enableCustom, property of the request body.

  • enableRadioTypeA (boolean) – enableRadioTypeA, property of the request body.

  • enableRadioTypeB (boolean) – enableRadioTypeB, property of the request body.

  • name (string) – Name, property of the request body.

  • radioTypeAProperties (object) – Radio Type AProperties, property of the request body.

  • radioTypeBProperties (object) – Radio Type BProperties, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless Access points.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 1.3.1).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

Parameters:
  • periodic_refresh (bool) – Is analysis periodically refreshed?.

  • source_ip (basestring) – Source IP address.

  • dest_ip (basestring) – Destination IP adress.

  • source_port (basestring) – Source port.

  • dest_port (basestring) – Destination port.

  • gt_create_time (basestring) – Analyses requested after this time.

  • lt_create_time (basestring) – Analyses requested before this time.

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – Task ID.

  • last_update_time (basestring) – Last update time.

  • limit (basestring) – Number of resources returned.

  • offset (basestring) – Start index of resources returned (1-based).

  • order (basestring) – Order by this field.

  • sort_by (basestring) – Sort by this field.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

Parameters:
  • controlPath (boolean) – FlowAnalysisRequest’s controlPath.

  • destIP (string) – FlowAnalysisRequest’s destIP.

  • destPort (string) – FlowAnalysisRequest’s destPort.

  • inclusions (list) – FlowAnalysisRequest’s inclusions (list of strings).

  • periodicRefresh (boolean) – FlowAnalysisRequest’s periodicRefresh.

  • protocol (string) – FlowAnalysisRequest’s protocol.

  • sourceIP (string) – FlowAnalysisRequest’s sourceIP.

  • sourcePort (string) – FlowAnalysisRequest’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 1.3.1).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor .

Parameters:
  • provisioning (list) – Provisioning, property of the request body (list of objects).

  • siteProfile (list) – Site Profile, property of the request body (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information.

Parameters:
  • device_ip (string) – Device Ip, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address.

Parameters:
  • device_ip (basestring) – Device to which the site has to be assigned.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 1.3.1).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site with area/building/floor with specified hierarchy.

Parameters:
  • name (basestring) – siteNameHierarchy (ex: global/groupName).

  • site_id (basestring) – site id.

  • type (basestring) – type (ex: area, building, floor).

  • offset (basestring) – offset/starting row.

  • limit (basestring) – Number of sites to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_membership(site_id, headers=None, **request_parameters)[source]

Getting the site children details and device details.

Parameters:
  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Site Hierarchy data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId.

Parameters:
  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • site_id (basestring) – Site id to which the device is assigned.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – site id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 1.3.1).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order='asc', version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%”.

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED.

  • version (basestring) – software Image Version.

  • image_series (basestring) – image Series.

  • image_name (basestring) – image Name.

  • is_tagged_golden (bool) – is Tagged Golden.

  • is_cco_recommended (bool) – is recommended from cisco.com.

  • is_cco_latest (bool) – is latest from cisco.com.

  • created_time (int) – time in milliseconds (epoch format).

  • image_size_greater_than (int) – size in bytes.

  • image_size_lesser_than (int) – size in bytes.

  • sort_by (basestring) – sort results by this field.

  • sort_order (basestring) – sort order ‘asc’ or ‘des’. Default is asc.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – Third party Image check.

  • third_party_vendor (basestring) – Third Party Vendor.

  • third_party_image_family (basestring) – Third Party image family.

  • third_party_application_type (basestring) – Third Party Application Type.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

Parameters:
  • schedule_at (basestring) – Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – Custom Description (Optional).

  • schedule_origin (basestring) – Originator of this call (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash.

Parameters:
  • schedule_validate (bool) – scheduleValidate, validates data before schedule (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 1.3.1).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level='0', member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.

Parameters:
  • memberToTags (list) – TagMemberDTO’s memberToTags (list of objects).

  • memberType (string) – TagMemberDTO’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count.

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size in kilobytes(KB).

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_id (basestring) – TagMember id to be removed from tag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level='0', limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – Entity type of the member. Possible values can be retrieved by using /tag/member/type API.

  • offset (basestring) – Used for pagination. It indicates the starting row number out of available member records.

  • limit (basestring) – Used to Number of maximum members to return in the result.

  • member_association_type (basestring) – Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria.

Parameters:
  • name (basestring) – Tag name is mandatory when filter operation is used.

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size in kilobytes(KB).

  • field (basestring) – Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.

  • sort_by (basestring) – Only supported attribute is name. SortyBy is mandatory when order is used.

  • order (basestring) – Available values are asc and des.

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 1.3.1).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – Sort results by this field.

  • order (basestring) – Sort order asc or dsc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid.

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – Index, minimum value is 0.

  • limit (int) – The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 1.3.1).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType.

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID.

Parameters:
  • vlan_id (basestring) – Vlan Name for e.g Vlan1, Vlan23 etc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol.

Parameters:
  • topology_type (basestring) – Type of topology(OSPF,ISIS,etc).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Network health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 1.3.1).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v1.3.3

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 1.3.3).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id.

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name.

Parameters:
  • offset (int) – The offset of the first application to be returned.

  • limit (int) – The maximum number of applications to be returned.

  • name (basestring) – Application’s name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id.

Parameters:
  • id (basestring) – Application’s Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 1.3.3).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • mac_address (basestring) – MAC Address of the client.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 1.3.3).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs.

Parameters:
  • commands (list) – CommandRunnerDTO’s commands (list of strings).

  • description (string) – CommandRunnerDTO’s description.

  • deviceUuids (list) – CommandRunnerDTO’s deviceUuids (list of strings).

  • name (string) – CommandRunnerDTO’s name.

  • timeout (number) – CommandRunnerDTO’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 1.3.3).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, software_type=None, software_version=None, headers=None, **request_parameters)[source]

List the templates available.

Parameters:
  • project_id (basestring) – projectId query parameter.

  • software_type (basestring) – softwareType query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • product_family (basestring) – productFamily query parameter.

  • product_series (basestring) – productSeries query parameter.

  • product_type (basestring) – productType query parameter.

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, headers=None, **request_parameters)[source]

Returns the projects in the system.

Parameters:
  • name (basestring) – Name of project to be searched.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Versioning for the current contents of the template.

Parameters:
  • comments (string) – TemplateVersionRequestDTO’s comments.

  • templateId (string) – TemplateVersionRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploys a template.

Parameters:
  • forcePushTemplate (boolean) – TemplateDeploymentInfo’s forcePushTemplate.

  • isComposite (boolean) – TemplateDeploymentInfo’s isComposite.

  • mainTemplateId (string) – TemplateDeploymentInfo’s mainTemplateId.

  • memberTemplateDeploymentInfo (list) – TemplateDeploymentInfo’s memberTemplateDeploymentInfo (list of any objects).

  • targetInfo (list) – TemplateDeploymentInfo’s targetInfo (list of objects).

  • templateId (string) – TemplateDeploymentInfo’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Returns details of the specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • latest_version (bool) – latestVersion query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

Returns the status of a deployed template.

Parameters:
  • deployment_id (basestring) – deploymentId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_template(template_id, headers=None, **request_parameters)[source]

Deletes an existing template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Returns the versions of a specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_project(project_id, headers=None, **request_parameters)[source]

Deletes an existing Project.

Parameters:
  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(params=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Previews an existing template.

Parameters:
  • params (object) – TemplatePreviewRequestDTO’s params.

  • templateId (string) – TemplatePreviewRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 1.3.3).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow.

Parameters:
  • deviceIdList (list) – UnclaimRequest’s deviceIdList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count.

Parameters:
  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings.

Parameters:
  • _id (string) – Settings’s _id.

  • aaaCredentials (object) – Settings’s aaaCredentials.

  • acceptEula (boolean) – Settings’s acceptEula.

  • defaultProfile (object) – Settings’s defaultProfile.

  • savaMappingList (list) – Settings’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Settings’s taskTimeOuts.

  • tenantId (string) – Settings’s tenantId.

  • version (number) – Settings’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state.

Parameters:
  • deviceResetList (list) – ResetRequest’s deviceResetList (list of objects).

  • projectId (string) – ResetRequest’s projectId.

  • workflowId (string) – ResetRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated lost of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • type (basestring, list, set, tuple) – Workflow Type.

  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow.

Parameters:
  • configFileUrl (string) – ClaimDeviceRequest’s configFileUrl.

  • configId (string) – ClaimDeviceRequest’s configId.

  • deviceClaimList (list) – ClaimDeviceRequest’s deviceClaimList (list of objects).

  • fileServiceId (string) – ClaimDeviceRequest’s fileServiceId.

  • imageId (string) – ClaimDeviceRequest’s imageId.

  • imageUrl (string) – ClaimDeviceRequest’s imageUrl.

  • populateInventory (boolean) – ClaimDeviceRequest’s populateInventory.

  • projectId (string) – ClaimDeviceRequest’s projectId.

  • workflowId (string) – ClaimDeviceRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, last_contact=None, limit=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination.

Parameters:
  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter.

Parameters:
  • serial_number (basestring) – Device Serial Number.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 1.3.3).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, location name and a wide variety of additional criteria. You can also use the asterisk in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET fqdnoripofdnacenterplatform/dna/intent/api/v1/network- device? hostname=myhost* & managementIpAddress=192.25.18.* For a complete list of parameter names that you can use for filtering this request, see the DNA Center API Reference documentation. Note: If id parameter is provided, it will return the list of network-devices for the given ids and ignores the other request parameters. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – Accepts comma separated id’s and return list of network-devices for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id.

Parameters:
  • id (basestring) – Device ID.

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs.

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – Vlan assocaited with sub-interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range.

Parameters:
  • device_id (basestring) – Device ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name.

Parameters:
  • device_id (basestring) – Device ID.

  • name (basestring) – Interface name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id.

Parameters:
  • id (basestring) – Functional Capability UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID.

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router.

Parameters:
  • id (string) – NetworkDeviceBriefNIO’s id.

  • role (string) – NetworkDeviceBriefNIO’s role.

  • roleSource (string) – NetworkDeviceBriefNIO’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file.

Parameters:
  • deviceUuids (list) – ExportDeviceDTO’s deviceUuids (list of strings).

  • id (string) – ExportDeviceDTO’s id.

  • operationEnum (string) – ExportDeviceDTO’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – ExportDeviceDTO’s parameters (list of strings).

  • password (string) – ExportDeviceDTO’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification.

Parameters:
  • serial_number (basestring) – Serial number of the device.

  • macaddress (basestring) – Mac addres of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID.

Parameters:
  • id (basestring) – Interface ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices.

Parameters:
  • device_id (basestring) – Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number.

Parameters:
  • serial_number (basestring) – Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces by specified IP address.

Parameters:
  • ip_address (basestring) – IP address of the interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address.

Parameters:
  • ip_address (basestring) – Device IP address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=500, offset=1, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the device data is required.

  • search_by (basestring) – MAC Address or Device Name value or UUID of the network device.

  • identifier (basestring) – One of keywords : macAddress or uuid or nwDeviceName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 1.3.3).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community.

Parameters:
  • comments (string) – SNMPv2WriteCommunityDTO’s comments.

  • credentialType (string) – SNMPv2WriteCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2WriteCommunityDTO’s description.

  • id (string) – SNMPv2WriteCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2WriteCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2WriteCommunityDTO’s instanceUuid.

  • writeCommunity (string) – SNMPv2WriteCommunityDTO’s writeCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential.

Parameters:
  • authPassword (string) – SNMPv3CredentialDTO’s authPassword.

  • authType (string) – SNMPv3CredentialDTO’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – SNMPv3CredentialDTO’s comments.

  • credentialType (string) – SNMPv3CredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv3CredentialDTO’s description.

  • id (string) – SNMPv3CredentialDTO’s id.

  • instanceTenantId (string) – SNMPv3CredentialDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv3CredentialDTO’s instanceUuid.

  • privacyPassword (string) – SNMPv3CredentialDTO’s privacyPassword.

  • privacyType (string) – SNMPv3CredentialDTO’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – SNMPv3CredentialDTO’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – SNMPv3CredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community.

Parameters:
  • comments (string) – SNMPv2ReadCommunityDTO’s comments.

  • credentialType (string) – SNMPv2ReadCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2ReadCommunityDTO’s description.

  • id (string) – SNMPv2ReadCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2ReadCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2ReadCommunityDTO’s instanceUuid.

  • readCommunity (string) – SNMPv2ReadCommunityDTO’s readCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id.

Parameters:
  • id (basestring) – Global Credential ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, noAddNewDevice=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, reDiscovery=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters.

Parameters:
  • cdpLevel (number) – InventoryRequest’s cdpLevel.

  • discoveryType (string) – InventoryRequest’s discoveryType.

  • enablePasswordList (list) – InventoryRequest’s enablePasswordList (list of string, objects).

  • globalCredentialIdList (list) – InventoryRequest’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – InventoryRequest’s httpReadCredential.

  • httpWriteCredential (object) – InventoryRequest’s httpWriteCredential.

  • ipAddressList (string) – InventoryRequest’s ipAddressList.

  • ipFilterList (list) – InventoryRequest’s ipFilterList (list of string, objects).

  • lldpLevel (number) – InventoryRequest’s lldpLevel.

  • name (string) – InventoryRequest’s name.

  • netconfPort (string) – InventoryRequest’s netconfPort.

  • noAddNewDevice (boolean) – InventoryRequest’s noAddNewDevice.

  • parentDiscoveryId (string) – InventoryRequest’s parentDiscoveryId.

  • passwordList (list) – InventoryRequest’s passwordList (list of string, objects).

  • preferredMgmtIPMethod (string) – InventoryRequest’s preferredMgmtIPMethod.

  • protocolOrder (string) – InventoryRequest’s protocolOrder.

  • reDiscovery (boolean) – InventoryRequest’s reDiscovery.

  • retry (number) – InventoryRequest’s retry.

  • snmpAuthPassphrase (string) – InventoryRequest’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryRequest’s snmpAuthProtocol.

  • snmpMode (string) – InventoryRequest’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryRequest’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryRequest’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryRequest’s snmpROCommunity.

  • snmpROCommunityDesc (string) – InventoryRequest’s snmpROCommunityDesc.

  • snmpRWCommunity (string) – InventoryRequest’s snmpRWCommunity.

  • snmpRWCommunityDesc (string) – InventoryRequest’s snmpRWCommunityDesc.

  • snmpUserName (string) – InventoryRequest’s snmpUserName.

  • snmpVersion (string) – InventoryRequest’s snmpVersion.

  • timeout (number) – InventoryRequest’s timeout.

  • updateMgmtIp (boolean) – InventoryRequest’s updateMgmtIp.

  • userNameList (list) – InventoryRequest’s userNameList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s).

Parameters:
  • siteUuids (list) – SitesInfoDTO’s siteUuids (list of strings).

  • global_credential_id (basestring) – Global credential Uuid.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential.

Parameters:
  • comments (string) – HTTPReadCredentialDTO’s comments.

  • credentialType (string) – HTTPReadCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPReadCredentialDTO’s description.

  • id (string) – HTTPReadCredentialDTO’s id.

  • instanceTenantId (string) – HTTPReadCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPReadCredentialDTO’s instanceUuid.

  • password (string) – HTTPReadCredentialDTO’s password.

  • port (number) – HTTPReadCredentialDTO’s port.

  • secure (boolean) – HTTPReadCredentialDTO’s secure.

  • username (string) – HTTPReadCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery.

Parameters:
  • attributeInfo (object) – DiscoveryNIO’s attributeInfo.

  • cdpLevel (number) – DiscoveryNIO’s cdpLevel.

  • deviceIds (string) – DiscoveryNIO’s deviceIds.

  • discoveryCondition (string) – DiscoveryNIO’s discoveryCondition.

  • discoveryStatus (string) – DiscoveryNIO’s discoveryStatus.

  • discoveryType (string) – DiscoveryNIO’s discoveryType.

  • enablePasswordList (string) – DiscoveryNIO’s enablePasswordList.

  • globalCredentialIdList (list) – DiscoveryNIO’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – DiscoveryNIO’s httpReadCredential.

  • httpWriteCredential (object) – DiscoveryNIO’s httpWriteCredential.

  • id (string) – DiscoveryNIO’s id.

  • ipAddressList (string) – DiscoveryNIO’s ipAddressList.

  • ipFilterList (string) – DiscoveryNIO’s ipFilterList.

  • isAutoCdp (boolean) – DiscoveryNIO’s isAutoCdp.

  • lldpLevel (number) – DiscoveryNIO’s lldpLevel.

  • name (string) – DiscoveryNIO’s name.

  • netconfPort (string) – DiscoveryNIO’s netconfPort.

  • numDevices (number) – DiscoveryNIO’s numDevices.

  • parentDiscoveryId (string) – DiscoveryNIO’s parentDiscoveryId.

  • passwordList (string) – DiscoveryNIO’s passwordList.

  • preferredMgmtIPMethod (string) – DiscoveryNIO’s preferredMgmtIPMethod.

  • protocolOrder (string) – DiscoveryNIO’s protocolOrder.

  • retryCount (number) – DiscoveryNIO’s retryCount.

  • snmpAuthPassphrase (string) – DiscoveryNIO’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – DiscoveryNIO’s snmpAuthProtocol.

  • snmpMode (string) – DiscoveryNIO’s snmpMode.

  • snmpPrivPassphrase (string) – DiscoveryNIO’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – DiscoveryNIO’s snmpPrivProtocol.

  • snmpRoCommunity (string) – DiscoveryNIO’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – DiscoveryNIO’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – DiscoveryNIO’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – DiscoveryNIO’s snmpRwCommunityDesc.

  • snmpUserName (string) – DiscoveryNIO’s snmpUserName.

  • timeOut (number) – DiscoveryNIO’s timeOut.

  • updateMgmtIp (boolean) – DiscoveryNIO’s updateMgmtIp.

  • userNameList (string) – DiscoveryNIO’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials.

Parameters:
  • comments (string) – HTTPWriteCredentialDTO’s comments.

  • credentialType (string) – HTTPWriteCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPWriteCredentialDTO’s description.

  • id (string) – HTTPWriteCredentialDTO’s id.

  • instanceTenantId (string) – HTTPWriteCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPWriteCredentialDTO’s instanceUuid.

  • password (string) – HTTPWriteCredentialDTO’s password.

  • port (number) – HTTPWriteCredentialDTO’s port.

  • secure (boolean) – HTTPWriteCredentialDTO’s secure.

  • username (string) – HTTPWriteCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials.

Parameters:
  • comments (string) – NetconfCredentialDTO’s comments.

  • credentialType (string) – NetconfCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – NetconfCredentialDTO’s description.

  • id (string) – NetconfCredentialDTO’s id.

  • instanceTenantId (string) – NetconfCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – NetconfCredentialDTO’s instanceUuid.

  • netconfPort (string) – NetconfCredentialDTO’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them.

Parameters:
  • start_index (int) – Start index.

  • records_to_delete (int) – Number of records to delete.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID.

Parameters:
  • global_credential_id (basestring) – ID of global-credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type.

Parameters:
  • credential_sub_type (basestring) – Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF.

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials.

Parameters:
  • comments (string) – CLICredentialDTO’s comments.

  • credentialType (string) – CLICredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – CLICredentialDTO’s description.

  • enablePassword (string) – CLICredentialDTO’s enablePassword.

  • id (string) – CLICredentialDTO’s id.

  • instanceTenantId (string) – CLICredentialDTO’s instanceTenantId.

  • instanceUuid (string) – CLICredentialDTO’s instanceUuid.

  • password (string) – CLICredentialDTO’s password.

  • username (string) – CLICredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 1.3.3).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=' ', limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • offset (int) – The number of Registries to offset in the resultset whose default value 0.

  • limit (int) – The number of Registries to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions.

Parameters:
  • subscriptions (basestring) – List of EventSubscriptionId’s for removal.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • offset (int) – The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter.

Parameters:
  • execution_id (basestring) – Execution ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=20, offset=None, order=None, severity=None, sort_by=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • offset (int) – Offset whose default value 0.

  • limit (int) – Limit whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 1.3.3).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace.

Parameters:
  • name_space (basestring) – A listing of fileId’s.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId.

Parameters:
  • file_id (basestring) – File Identification number.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 1.3.3).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 1.3.3).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential.

Parameters:
  • id (basestring) – global credential id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential To Site .

Parameters:
  • cliId (string) – Cli Id, property of the request body.

  • httpRead (string) – Http Read, property of the request body.

  • httpWrite (string) – Http Write, property of the request body.

  • snmpV2ReadId (string) – Snmp V2 Read Id, property of the request body.

  • snmpV2WriteId (string) – Snmp V2 Write Id, property of the request body.

  • snmpV3Id (string) – Snmp V3 Id, property of the request body.

  • site_id (basestring) – site id to assign credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details.

Parameters:
  • site_id (basestring) – Site id to get the network settings associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS).

Parameters:
  • sp_profile_name (basestring) – sp profile name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update SP profile.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool.

Parameters:
  • id (basestring) – global pool id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Settings, property of the request body.

  • site_id (basestring) – Site id to update the network settings which is associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS).

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details.

Parameters:
  • site_id (basestring) – Site id to retrieve the credential details associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create service provider profile(QOS).

Parameters:
  • settings (object) – settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool.

Parameters:
  • offset (basestring) – offset/starting row.

  • limit (basestring) – No of Global Pools to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Settings, property of the request body.

  • site_id (basestring) – Site id to which site details to associate with the network settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 1.3.3).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

Parameters:
  • periodic_refresh (bool) – Is analysis periodically refreshed?.

  • source_ip (basestring) – Source IP address.

  • dest_ip (basestring) – Destination IP adress.

  • source_port (basestring) – Source port.

  • dest_port (basestring) – Destination port.

  • gt_create_time (basestring) – Analyses requested after this time.

  • lt_create_time (basestring) – Analyses requested before this time.

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – Task ID.

  • last_update_time (basestring) – Last update time.

  • limit (basestring) – Number of resources returned.

  • offset (basestring) – Start index of resources returned (1-based).

  • order (basestring) – Order by this field.

  • sort_by (basestring) – Sort by this field.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

Parameters:
  • controlPath (boolean) – FlowAnalysisRequest’s controlPath.

  • destIP (string) – FlowAnalysisRequest’s destIP.

  • destPort (string) – FlowAnalysisRequest’s destPort.

  • inclusions (list) – FlowAnalysisRequest’s inclusions (list of strings).

  • periodicRefresh (boolean) – FlowAnalysisRequest’s periodicRefresh.

  • protocol (string) – FlowAnalysisRequest’s protocol.

  • sourceIP (string) – FlowAnalysisRequest’s sourceIP.

  • sourcePort (string) – FlowAnalysisRequest’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sda

class Sda[source]

Cisco DNA Center SDA API (version: 1.3.3).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

delete_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_info(fabric_name, headers=None, **request_parameters)[source]

Get SDA Fabric Info.

Parameters:
  • fabric_name (basestring) – Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric.

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_info(device_ipaddress, headers=None, **request_parameters)[source]

Get device info from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_vn(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_fabric(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_ipaddress, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_access_point(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sda_fabric(fabric_name, headers=None, **request_parameters)[source]

Delete SDA Fabric.

Parameters:
  • fabric_name (basestring) – Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_ipaddress, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_control_plane_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_site(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 1.3.3).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information.

Parameters:
  • device_ip (string) – Device Ip, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor .

Parameters:
  • provisioning (list) – Provisioning, property of the request body (list of objects).

  • siteProfile (list) – Site Profile, property of the request body (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address.

Parameters:
  • device_ip (basestring) – Device to which the provisioning detail has to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 1.3.3).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • site_id (basestring) – Site id to which site the device to assign.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Site Hierarchy data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site with area/building/floor with specified hierarchy.

Parameters:
  • name (basestring) – siteNameHierarchy (ex: global/groupName).

  • site_id (basestring) – Site id to which site details to retrieve.

  • type (basestring) – type (ex: area, building, floor).

  • offset (basestring) – offset/starting row.

  • limit (basestring) – Number of sites to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – Site id to retrieve site count.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId.

Parameters:
  • site_id (basestring) – Site id to which site details to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – Site id to which site details to be updated.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_membership(site_id, headers=None, **request_parameters)[source]

Getting the site children details and device details.

Parameters:
  • site_id (basestring) – Site id to retrieve device associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 1.3.3).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order='asc', version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%”.

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED.

  • version (basestring) – software Image Version.

  • image_series (basestring) – image Series.

  • image_name (basestring) – image Name.

  • is_tagged_golden (bool) – is Tagged Golden.

  • is_cco_recommended (bool) – is recommended from cisco.com.

  • is_cco_latest (bool) – is latest from cisco.com.

  • created_time (int) – time in milliseconds (epoch format).

  • image_size_greater_than (int) – size in bytes.

  • image_size_lesser_than (int) – size in bytes.

  • sort_by (basestring) – sort results by this field.

  • sort_order (basestring) – sort order ‘asc’ or ‘des’. Default is asc.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – Third party Image check.

  • third_party_vendor (basestring) – Third Party Vendor.

  • third_party_image_family (basestring) – Third Party image family.

  • third_party_application_type (basestring) – Third Party Application Type.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

Parameters:
  • schedule_at (basestring) – Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – Custom Description (Optional).

  • schedule_origin (basestring) – Originator of this call (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash.

Parameters:
  • schedule_validate (bool) – scheduleValidate, validates data before schedule (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 1.3.3).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level='0', member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.

Parameters:
  • memberToTags (list) – TagMemberDTO’s memberToTags (list of objects).

  • memberType (string) – TagMemberDTO’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count.

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size in kilobytes(KB).

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_id (basestring) – TagMember id to be removed from tag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria.

Parameters:
  • name (basestring) – Tag name is mandatory when filter operation is used.

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size in kilobytes(KB).

  • field (basestring) – Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.

  • sort_by (basestring) – Only supported attribute is name. SortyBy is mandatory when order is used.

  • order (basestring) – Available values are asc and des.

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level='0', limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – Entity type of the member. Possible values can be retrieved by using /tag/member/type API.

  • offset (basestring) – Used for pagination. It indicates the starting row number out of available member records.

  • limit (basestring) – Used to Number of maximum members to return in the result.

  • member_association_type (basestring) – Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 1.3.3).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid.

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – Index, minimum value is 0.

  • limit (int) – The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – Sort results by this field.

  • order (basestring) – Sort order asc or dsc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 1.3.3).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType.

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID.

Parameters:
  • vlan_id (basestring) – Vlan Name for e.g Vlan1, Vlan23 etc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol.

Parameters:
  • topology_type (basestring) – Type of topology(OSPF,ISIS,etc).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Network health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 1.3.3).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 1.3.3).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles.

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites.

Parameters:
  • enableFabric (boolean) – enableFabric, property of the request body.

  • flexConnect (object) – Flex Connect Applicable for non fabric profile, property of the request body.

  • managedAPLocations (list) – Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body (list of strings).

  • ssidDetails (object) – SsidDetails, property of the request body.

  • ssidType (string) – SSID Type, property of the request body. Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s).

Parameters:
  • rf_profile_name (basestring) – rf-profile-name path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(enableBroadcastSSID=None, enableFastLane=None, enableMACFiltering=None, fastTransition=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID.

Parameters:
  • enableBroadcastSSID (boolean) – enableBroadcastSSID, property of the request body.

  • enableFastLane (boolean) – enableFastLane, property of the request body.

  • enableMACFiltering (boolean) – enableMACFiltering, property of the request body.

  • fastTransition (string) – Fast Transition, property of the request body. Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • name (string) – Enter SSID Name, property of the request body. Constraints: maxLength set to 32.

  • passphrase (string) – Pass Phrase (Only applicable for SSID with PERSONAL security level), property of the request body. Constraints: maxLength set to 63 and minLength set to 8.

  • radioPolicy (string) – Radio Policy, property of the request body. Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Security Level, property of the request body. Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • trafficType (string) – Traffic Type, property of the request body. Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile.

Parameters:
  • profile_name (basestring) – profileName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile.

Parameters:
  • channelWidth (string) – Channel Width, property of the request body.

  • defaultRfProfile (boolean) – defaultRfProfile, property of the request body.

  • enableBrownField (boolean) – enableBrownField, property of the request body.

  • enableCustom (boolean) – enableCustom, property of the request body.

  • enableRadioTypeA (boolean) – enableRadioTypeA, property of the request body.

  • enableRadioTypeB (boolean) – enableRadioTypeB, property of the request body.

  • name (string) – Name, property of the request body.

  • radioTypeAProperties (object) – Radio Type AProperties, property of the request body.

  • radioTypeBProperties (object) – Radio Type BProperties, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless Access points.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided.

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center.

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v2.1.1

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 2.1.1).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id.

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name.

Parameters:
  • offset (int) – The offset of the first application to be returned.

  • limit (int) – The maximum number of applications to be returned.

  • name (basestring) – Application’s name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id.

Parameters:
  • id (basestring) – Application’s Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 2.1.1).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • mac_address (basestring) – MAC Address of the client.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 2.1.1).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs.

Parameters:
  • commands (list) – CommandRunnerDTO’s commands (list of strings).

  • description (string) – CommandRunnerDTO’s description.

  • deviceUuids (list) – CommandRunnerDTO’s deviceUuids (list of strings).

  • name (string) – CommandRunnerDTO’s name.

  • timeout (number) – CommandRunnerDTO’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 2.1.1).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, software_type=None, software_version=None, headers=None, **request_parameters)[source]

List the templates available.

Parameters:
  • project_id (basestring) – projectId query parameter.

  • software_type (basestring) – softwareType query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • product_family (basestring) – productFamily query parameter.

  • product_series (basestring) – productSeries query parameter.

  • product_type (basestring) – productType query parameter.

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, headers=None, **request_parameters)[source]

Returns the projects in the system.

Parameters:
  • name (basestring) – Name of project to be searched.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploys a template.

Parameters:
  • forcePushTemplate (boolean) – TemplateDeploymentInfo’s forcePushTemplate.

  • isComposite (boolean) – TemplateDeploymentInfo’s isComposite.

  • mainTemplateId (string) – TemplateDeploymentInfo’s mainTemplateId.

  • memberTemplateDeploymentInfo (list) – TemplateDeploymentInfo’s memberTemplateDeploymentInfo (list of any objects).

  • targetInfo (list) – TemplateDeploymentInfo’s targetInfo (list of objects).

  • templateId (string) – TemplateDeploymentInfo’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Versioning for the current contents of the template.

Parameters:
  • comments (string) – TemplateVersionRequestDTO’s comments.

  • templateId (string) – TemplateVersionRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Returns details of the specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • latest_version (bool) – latestVersion query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

Returns the status of a deployed template.

Parameters:
  • deployment_id (basestring) – deploymentId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_template(template_id, headers=None, **request_parameters)[source]

Deletes an existing template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Returns the versions of a specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_project(project_id, headers=None, **request_parameters)[source]

Deletes an existing Project.

Parameters:
  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(params=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Previews an existing template.

Parameters:
  • params (object) – TemplatePreviewRequestDTO’s params.

  • templateId (string) – TemplatePreviewRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 2.1.1).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow.

Parameters:
  • deviceIdList (list) – UnclaimRequest’s deviceIdList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count.

Parameters:
  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings.

Parameters:
  • _id (string) – Settings’s _id.

  • aaaCredentials (object) – Settings’s aaaCredentials.

  • acceptEula (boolean) – Settings’s acceptEula.

  • defaultProfile (object) – Settings’s defaultProfile.

  • savaMappingList (list) – Settings’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Settings’s taskTimeOuts.

  • tenantId (string) – Settings’s tenantId.

  • version (number) – Settings’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated lost of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • type (basestring, list, set, tuple) – Workflow Type.

  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state.

Parameters:
  • deviceResetList (list) – ResetRequest’s deviceResetList (list of objects).

  • projectId (string) – ResetRequest’s projectId.

  • workflowId (string) – ResetRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination.

Parameters:
  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter.

Parameters:
  • serial_number (basestring) – Device Serial Number.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow.

Parameters:
  • configFileUrl (string) – ClaimDeviceRequest’s configFileUrl.

  • configId (string) – ClaimDeviceRequest’s configId.

  • deviceClaimList (list) – ClaimDeviceRequest’s deviceClaimList (list of objects).

  • fileServiceId (string) – ClaimDeviceRequest’s fileServiceId.

  • imageId (string) – ClaimDeviceRequest’s imageId.

  • imageUrl (string) – ClaimDeviceRequest’s imageUrl.

  • populateInventory (boolean) – ClaimDeviceRequest’s populateInventory.

  • projectId (string) – ClaimDeviceRequest’s projectId.

  • workflowId (string) – ClaimDeviceRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, last_contact=None, limit=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_replacement

class DeviceReplacement[source]

Cisco DNA Center Device Replacement API (version: 2.1.1).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images.

Parameters:
  • faultyDeviceSerialNumber (string) – DeviceReplacementWorkflowDTO’s faultyDeviceSerialNumber.

  • replacementDeviceSerialNumber (string) – DeviceReplacementWorkflowDTO’s replacementDeviceSerialNumber.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

UnMarks device for replacement.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Marks device for replacement.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)[source]

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family.

Parameters:
  • faulty_device_name (basestring) – Faulty Device Name.

  • faulty_device_platform (basestring) – Faulty Device Platform.

  • replacement_device_platform (basestring) – Replacement Device Platform.

  • faulty_device_serial_number (basestring) – Faulty Device Serial Number.

  • replacement_device_serial_number (basestring) – Replacement Device Serial Number.

  • replacement_status (basestring, list, set, tuple) – Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED].

  • family (basestring, list, set, tuple) – List of families[Routers, Switches and Hubs, AP].

  • sort_by (basestring) – SortBy this field. SortBy is mandatory when order is used.

  • sort_order (basestring) – Order on displayName[ASC,DESC].

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)[source]

Get replacement devices count.

Parameters:
  • replacement_status (basestring, list, set, tuple) – Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR].

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 2.1.1).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, location name and a wide variety of additional criteria. You can also use the asterisk in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET fqdnoripofdnacenterplatform/dna/intent/api/v1/network- device? hostname=myhost* & managementIpAddress=192.25.18.* For a complete list of parameter names that you can use for filtering this request, see the DNA Center API Reference documentation. Note: If id parameter is provided, it will return the list of network-devices for the given ids and ignores the other request parameters. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – Accepts comma separated id’s and return list of network-devices for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs.

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – Vlan assocaited with sub-interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id.

Parameters:
  • id (basestring) – Device ID.

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range.

Parameters:
  • device_id (basestring) – Device ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name.

Parameters:
  • device_id (basestring) – Device ID.

  • name (basestring) – Interface name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id.

Parameters:
  • id (basestring) – Functional Capability UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID.

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID.

Parameters:
  • id (basestring) – Interface ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router.

Parameters:
  • id (string) – NetworkDeviceBriefNIO’s id.

  • role (string) – NetworkDeviceBriefNIO’s role.

  • roleSource (string) – NetworkDeviceBriefNIO’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices.

Parameters:
  • device_id (basestring) – Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces by specified IP address.

Parameters:
  • ip_address (basestring) – IP address of the interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address.

Parameters:
  • ip_address (basestring) – Device IP address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file.

Parameters:
  • deviceUuids (list) – ExportDeviceDTO’s deviceUuids (list of strings).

  • id (string) – ExportDeviceDTO’s id.

  • operationEnum (string) – ExportDeviceDTO’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – ExportDeviceDTO’s parameters (list of strings).

  • password (string) – ExportDeviceDTO’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification.

Parameters:
  • serial_number (basestring) – Serial number of the device.

  • macaddress (basestring) – Mac addres of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number.

Parameters:
  • serial_number (basestring) – Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=500, offset=1, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the device data is required.

  • search_by (basestring) – MAC Address or Device Name value or UUID of the network device.

  • identifier (basestring) – One of keywords : macAddress or uuid or nwDeviceName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 2.1.1).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community.

Parameters:
  • comments (string) – SNMPv2WriteCommunityDTO’s comments.

  • credentialType (string) – SNMPv2WriteCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2WriteCommunityDTO’s description.

  • id (string) – SNMPv2WriteCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2WriteCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2WriteCommunityDTO’s instanceUuid.

  • writeCommunity (string) – SNMPv2WriteCommunityDTO’s writeCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential.

Parameters:
  • authPassword (string) – SNMPv3CredentialDTO’s authPassword.

  • authType (string) – SNMPv3CredentialDTO’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – SNMPv3CredentialDTO’s comments.

  • credentialType (string) – SNMPv3CredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv3CredentialDTO’s description.

  • id (string) – SNMPv3CredentialDTO’s id.

  • instanceTenantId (string) – SNMPv3CredentialDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv3CredentialDTO’s instanceUuid.

  • privacyPassword (string) – SNMPv3CredentialDTO’s privacyPassword.

  • privacyType (string) – SNMPv3CredentialDTO’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – SNMPv3CredentialDTO’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – SNMPv3CredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community.

Parameters:
  • comments (string) – SNMPv2ReadCommunityDTO’s comments.

  • credentialType (string) – SNMPv2ReadCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2ReadCommunityDTO’s description.

  • id (string) – SNMPv2ReadCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2ReadCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2ReadCommunityDTO’s instanceUuid.

  • readCommunity (string) – SNMPv2ReadCommunityDTO’s readCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, noAddNewDevice=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, reDiscovery=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters.

Parameters:
  • cdpLevel (number) – InventoryRequest’s cdpLevel.

  • discoveryType (string) – InventoryRequest’s discoveryType.

  • enablePasswordList (list) – InventoryRequest’s enablePasswordList (list of string, objects).

  • globalCredentialIdList (list) – InventoryRequest’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – InventoryRequest’s httpReadCredential.

  • httpWriteCredential (object) – InventoryRequest’s httpWriteCredential.

  • ipAddressList (string) – InventoryRequest’s ipAddressList.

  • ipFilterList (list) – InventoryRequest’s ipFilterList (list of string, objects).

  • lldpLevel (number) – InventoryRequest’s lldpLevel.

  • name (string) – InventoryRequest’s name.

  • netconfPort (string) – InventoryRequest’s netconfPort.

  • noAddNewDevice (boolean) – InventoryRequest’s noAddNewDevice.

  • parentDiscoveryId (string) – InventoryRequest’s parentDiscoveryId.

  • passwordList (list) – InventoryRequest’s passwordList (list of string, objects).

  • preferredMgmtIPMethod (string) – InventoryRequest’s preferredMgmtIPMethod.

  • protocolOrder (string) – InventoryRequest’s protocolOrder.

  • reDiscovery (boolean) – InventoryRequest’s reDiscovery.

  • retry (number) – InventoryRequest’s retry.

  • snmpAuthPassphrase (string) – InventoryRequest’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryRequest’s snmpAuthProtocol.

  • snmpMode (string) – InventoryRequest’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryRequest’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryRequest’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryRequest’s snmpROCommunity.

  • snmpROCommunityDesc (string) – InventoryRequest’s snmpROCommunityDesc.

  • snmpRWCommunity (string) – InventoryRequest’s snmpRWCommunity.

  • snmpRWCommunityDesc (string) – InventoryRequest’s snmpRWCommunityDesc.

  • snmpUserName (string) – InventoryRequest’s snmpUserName.

  • snmpVersion (string) – InventoryRequest’s snmpVersion.

  • timeout (number) – InventoryRequest’s timeout.

  • updateMgmtIp (boolean) – InventoryRequest’s updateMgmtIp.

  • userNameList (list) – InventoryRequest’s userNameList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id.

Parameters:
  • id (basestring) – Global Credential ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s).

Parameters:
  • siteUuids (list) – SitesInfoDTO’s siteUuids (list of strings).

  • global_credential_id (basestring) – Global credential Uuid.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential.

Parameters:
  • comments (string) – HTTPReadCredentialDTO’s comments.

  • credentialType (string) – HTTPReadCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPReadCredentialDTO’s description.

  • id (string) – HTTPReadCredentialDTO’s id.

  • instanceTenantId (string) – HTTPReadCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPReadCredentialDTO’s instanceUuid.

  • password (string) – HTTPReadCredentialDTO’s password.

  • port (number) – HTTPReadCredentialDTO’s port.

  • secure (boolean) – HTTPReadCredentialDTO’s secure.

  • username (string) – HTTPReadCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery.

Parameters:
  • attributeInfo (object) – DiscoveryNIO’s attributeInfo.

  • cdpLevel (number) – DiscoveryNIO’s cdpLevel.

  • deviceIds (string) – DiscoveryNIO’s deviceIds.

  • discoveryCondition (string) – DiscoveryNIO’s discoveryCondition.

  • discoveryStatus (string) – DiscoveryNIO’s discoveryStatus.

  • discoveryType (string) – DiscoveryNIO’s discoveryType.

  • enablePasswordList (string) – DiscoveryNIO’s enablePasswordList.

  • globalCredentialIdList (list) – DiscoveryNIO’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – DiscoveryNIO’s httpReadCredential.

  • httpWriteCredential (object) – DiscoveryNIO’s httpWriteCredential.

  • id (string) – DiscoveryNIO’s id.

  • ipAddressList (string) – DiscoveryNIO’s ipAddressList.

  • ipFilterList (string) – DiscoveryNIO’s ipFilterList.

  • isAutoCdp (boolean) – DiscoveryNIO’s isAutoCdp.

  • lldpLevel (number) – DiscoveryNIO’s lldpLevel.

  • name (string) – DiscoveryNIO’s name.

  • netconfPort (string) – DiscoveryNIO’s netconfPort.

  • numDevices (number) – DiscoveryNIO’s numDevices.

  • parentDiscoveryId (string) – DiscoveryNIO’s parentDiscoveryId.

  • passwordList (string) – DiscoveryNIO’s passwordList.

  • preferredMgmtIPMethod (string) – DiscoveryNIO’s preferredMgmtIPMethod.

  • protocolOrder (string) – DiscoveryNIO’s protocolOrder.

  • retryCount (number) – DiscoveryNIO’s retryCount.

  • snmpAuthPassphrase (string) – DiscoveryNIO’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – DiscoveryNIO’s snmpAuthProtocol.

  • snmpMode (string) – DiscoveryNIO’s snmpMode.

  • snmpPrivPassphrase (string) – DiscoveryNIO’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – DiscoveryNIO’s snmpPrivProtocol.

  • snmpRoCommunity (string) – DiscoveryNIO’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – DiscoveryNIO’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – DiscoveryNIO’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – DiscoveryNIO’s snmpRwCommunityDesc.

  • snmpUserName (string) – DiscoveryNIO’s snmpUserName.

  • timeOut (number) – DiscoveryNIO’s timeOut.

  • updateMgmtIp (boolean) – DiscoveryNIO’s updateMgmtIp.

  • userNameList (string) – DiscoveryNIO’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials.

Parameters:
  • comments (string) – HTTPWriteCredentialDTO’s comments.

  • credentialType (string) – HTTPWriteCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPWriteCredentialDTO’s description.

  • id (string) – HTTPWriteCredentialDTO’s id.

  • instanceTenantId (string) – HTTPWriteCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPWriteCredentialDTO’s instanceUuid.

  • password (string) – HTTPWriteCredentialDTO’s password.

  • port (number) – HTTPWriteCredentialDTO’s port.

  • secure (boolean) – HTTPWriteCredentialDTO’s secure.

  • username (string) – HTTPWriteCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials.

Parameters:
  • comments (string) – NetconfCredentialDTO’s comments.

  • credentialType (string) – NetconfCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – NetconfCredentialDTO’s description.

  • id (string) – NetconfCredentialDTO’s id.

  • instanceTenantId (string) – NetconfCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – NetconfCredentialDTO’s instanceUuid.

  • netconfPort (string) – NetconfCredentialDTO’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them.

Parameters:
  • start_index (int) – Start index.

  • records_to_delete (int) – Number of records to delete.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID.

Parameters:
  • global_credential_id (basestring) – ID of global-credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials.

Parameters:
  • comments (string) – CLICredentialDTO’s comments.

  • credentialType (string) – CLICredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – CLICredentialDTO’s description.

  • enablePassword (string) – CLICredentialDTO’s enablePassword.

  • id (string) – CLICredentialDTO’s id.

  • instanceTenantId (string) – CLICredentialDTO’s instanceTenantId.

  • instanceUuid (string) – CLICredentialDTO’s instanceUuid.

  • password (string) – CLICredentialDTO’s password.

  • username (string) – CLICredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type.

Parameters:
  • credential_sub_type (basestring) – Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF.

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 2.1.1).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=' ', limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • offset (int) – The number of Registries to offset in the resultset whose default value 0.

  • limit (int) – The number of Registries to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions.

Parameters:
  • subscriptions (basestring) – List of EventSubscriptionId’s for removal.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • offset (int) – The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter.

Parameters:
  • execution_id (basestring) – Execution ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=20, offset=None, order=None, severity=None, sort_by=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • offset (int) – Offset whose default value 0.

  • limit (int) – Limit whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 2.1.1).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace.

Parameters:
  • name_space (basestring) – A listing of fileId’s.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId.

Parameters:
  • file_id (basestring) – File Identification number.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

itsm

class Itsm[source]

Cisco DNA Center ITSM API (version: 2.1.1).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)[source]

Used to retrieve the list of integration events that failed to create tickets in ITSM.

Parameters:
  • instance_id (basestring) – Instance Id of the failed event as in the Runtime Dashboard.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 2.1.1).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 2.1.1).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details.

Parameters:
  • site_id (basestring) – Site id to get the network settings associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS).

Parameters:
  • sp_profile_name (basestring) – sp profile name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool.

Parameters:
  • id (basestring) – global pool id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update SP profile.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential.

Parameters:
  • id (basestring) – global credential id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential To Site .

Parameters:
  • cliId (string) – Cli Id, property of the request body.

  • httpRead (string) – Http Read, property of the request body.

  • httpWrite (string) – Http Write, property of the request body.

  • snmpV2ReadId (string) – Snmp V2 Read Id, property of the request body.

  • snmpV2WriteId (string) – Snmp V2 Write Id, property of the request body.

  • snmpV3Id (string) – Snmp V3 Id, property of the request body.

  • site_id (basestring) – site id to assign credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Settings, property of the request body.

  • site_id (basestring) – Site id to update the network settings which is associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS).

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details.

Parameters:
  • site_id (basestring) – Site id to retrieve the credential details associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create service provider profile(QOS).

Parameters:
  • settings (object) – settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool.

Parameters:
  • offset (basestring) – offset/starting row.

  • limit (basestring) – No of Global Pools to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Settings, property of the request body.

  • site_id (basestring) – Site id to which site details to associate with the network settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 2.1.1).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

Parameters:
  • periodic_refresh (bool) – Is analysis periodically refreshed?.

  • source_ip (basestring) – Source IP address.

  • dest_ip (basestring) – Destination IP adress.

  • source_port (basestring) – Source port.

  • dest_port (basestring) – Destination port.

  • gt_create_time (basestring) – Analyses requested after this time.

  • lt_create_time (basestring) – Analyses requested before this time.

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – Task ID.

  • last_update_time (basestring) – Last update time.

  • limit (basestring) – Number of resources returned.

  • offset (basestring) – Start index of resources returned (1-based).

  • order (basestring) – Order by this field.

  • sort_by (basestring) – Sort by this field.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

Parameters:
  • controlPath (boolean) – FlowAnalysisRequest’s controlPath.

  • destIP (string) – FlowAnalysisRequest’s destIP.

  • destPort (string) – FlowAnalysisRequest’s destPort.

  • inclusions (list) – FlowAnalysisRequest’s inclusions (list of strings).

  • periodicRefresh (boolean) – FlowAnalysisRequest’s periodicRefresh.

  • protocol (string) – FlowAnalysisRequest’s protocol.

  • sourceIP (string) – FlowAnalysisRequest’s sourceIP.

  • sourcePort (string) – FlowAnalysisRequest’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sda

class Sda[source]

Cisco DNA Center SDA API (version: 2.1.1).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

get_sda_fabric_info(fabric_name, headers=None, **request_parameters)[source]

Get SDA Fabric Info.

Parameters:
  • fabric_name (basestring) – Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_info(device_ipaddress, headers=None, **request_parameters)[source]

Get device info from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric.

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_vn(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_fabric(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_ipaddress, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_site(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_access_point(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_control_plane_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_ipaddress, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sda_fabric(fabric_name, headers=None, **request_parameters)[source]

Delete SDA Fabric.

Parameters:
  • fabric_name (basestring) – Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 2.1.1).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

API to get NFV network profile.

Parameters:
  • id (basestring) – ID of network profile to retrieve.

  • offset (basestring) – offset/starting row.

  • limit (basestring) – Number of profile to be retrieved.

  • name (basestring) – Name of network profile to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a NFV Network profile.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • id (basestring) – Id of the NFV profile to be updated.

  • name (basestring) – Name of the profile to be updated.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information.

Parameters:
  • device_ip (string) – Device Ip, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_nfv_profile(id, name=None, headers=None, **request_parameters)[source]

API to delete nfv network profile.

Parameters:
  • id (basestring) – Id of nfv network profile to delete. .

  • name (basestring) – Nameof nfv network profile to delete. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network profile for different NFV topologies.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • profileName (string) – Site Profile Name, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor .

Parameters:
  • provisioning (list) – Provisioning, property of the request body (list of objects).

  • siteProfile (list) – Site Profile, property of the request body (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address.

Parameters:
  • device_ip (basestring) – Device to which the provisioning detail has to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 2.1.1).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • site_id (basestring) – Site id to which site the device to assign.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Site Hierarchy data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site with area/building/floor with specified hierarchy.

Parameters:
  • name (basestring) – siteNameHierarchy (ex: global/groupName).

  • site_id (basestring) – Site id to which site details to retrieve.

  • type (basestring) – type (ex: area, building, floor).

  • offset (basestring) – offset/starting row.

  • limit (basestring) – Number of sites to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – Site id to retrieve site count.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId.

Parameters:
  • site_id (basestring) – Site id to which site details to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_membership(site_id, headers=None, **request_parameters)[source]

Getting the site children details and device details.

Parameters:
  • site_id (basestring) – Site id to retrieve device associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – Site id to which site details to be updated.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 2.1.1).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order='asc', version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%”.

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED.

  • version (basestring) – software Image Version.

  • image_series (basestring) – image Series.

  • image_name (basestring) – image Name.

  • is_tagged_golden (bool) – is Tagged Golden.

  • is_cco_recommended (bool) – is recommended from cisco.com.

  • is_cco_latest (bool) – is latest from cisco.com.

  • created_time (int) – time in milliseconds (epoch format).

  • image_size_greater_than (int) – size in bytes.

  • image_size_lesser_than (int) – size in bytes.

  • sort_by (basestring) – sort results by this field.

  • sort_order (basestring) – sort order ‘asc’ or ‘des’. Default is asc.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – Third party Image check.

  • third_party_vendor (basestring) – Third Party Vendor.

  • third_party_image_family (basestring) – Third Party image family.

  • third_party_application_type (basestring) – Third Party Application Type.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

Parameters:
  • schedule_at (basestring) – Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – Custom Description (Optional).

  • schedule_origin (basestring) – Originator of this call (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash.

Parameters:
  • schedule_validate (bool) – scheduleValidate, validates data before schedule (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 2.1.1).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level='0', member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.

Parameters:
  • memberToTags (list) – TagMemberDTO’s memberToTags (list of objects).

  • memberType (string) – TagMemberDTO’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count.

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size in kilobytes(KB).

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_id (basestring) – TagMember id to be removed from tag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level='0', limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – Entity type of the member. Possible values can be retrieved by using /tag/member/type API.

  • offset (basestring) – Used for pagination. It indicates the starting row number out of available member records.

  • limit (basestring) – Used to Number of maximum members to return in the result.

  • member_association_type (basestring) – Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria.

Parameters:
  • name (basestring) – Tag name is mandatory when filter operation is used.

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size in kilobytes(KB).

  • field (basestring) – Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.

  • sort_by (basestring) – Only supported attribute is name. SortyBy is mandatory when order is used.

  • order (basestring) – Available values are asc and des.

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 2.1.1).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – Sort results by this field.

  • order (basestring) – Sort order asc or dsc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid.

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – Index, minimum value is 0.

  • limit (int) – The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 2.1.1).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType.

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID.

Parameters:
  • vlan_id (basestring) – Vlan Name for e.g Vlan1, Vlan23 etc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol.

Parameters:
  • topology_type (basestring) – Type of topology(OSPF,ISIS,etc).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Network health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 2.1.1).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 2.1.1).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles.

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites.

Parameters:
  • enableFabric (boolean) – enableFabric, property of the request body.

  • flexConnect (object) – Flex Connect Applicable for non fabric profile, property of the request body.

  • managedAPLocations (list) – Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body (list of strings).

  • ssidDetails (object) – SsidDetails, property of the request body.

  • ssidType (string) – SSID Type, property of the request body. Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s).

Parameters:
  • rf_profile_name (basestring) – rf-profile-name path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(enableBroadcastSSID=None, enableFastLane=None, enableMACFiltering=None, fastTransition=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID.

Parameters:
  • enableBroadcastSSID (boolean) – enableBroadcastSSID, property of the request body.

  • enableFastLane (boolean) – enableFastLane, property of the request body.

  • enableMACFiltering (boolean) – enableMACFiltering, property of the request body.

  • fastTransition (string) – Fast Transition, property of the request body. Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • name (string) – Enter SSID Name, property of the request body. Constraints: maxLength set to 32.

  • passphrase (string) – Pass Phrase (Only applicable for SSID with PERSONAL security level), property of the request body. Constraints: maxLength set to 63 and minLength set to 8.

  • radioPolicy (string) – Radio Policy, property of the request body. Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Security Level, property of the request body. Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • trafficType (string) – Traffic Type, property of the request body. Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile.

Parameters:
  • profile_name (basestring) – profileName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile.

Parameters:
  • channelWidth (string) – Channel Width, property of the request body.

  • defaultRfProfile (boolean) – defaultRfProfile, property of the request body.

  • enableBrownField (boolean) – enableBrownField, property of the request body.

  • enableCustom (boolean) – enableCustom, property of the request body.

  • enableRadioTypeA (boolean) – enableRadioTypeA, property of the request body.

  • enableRadioTypeB (boolean) – enableRadioTypeB, property of the request body.

  • name (string) – Name, property of the request body.

  • radioTypeAProperties (object) – Radio Type AProperties, property of the request body.

  • radioTypeBProperties (object) – Radio Type BProperties, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless Access points.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision_and_re_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Access Point Provision and ReProvision .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided.

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center.

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v2.1.2

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 2.1.2).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name.

Parameters:
  • offset (int) – The offset of the first application to be returned.

  • limit (int) – The maximum number of applications to be returned.

  • name (basestring) – Application’s name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id.

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets(limit=500, name=None, offset=1, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id.

Parameters:
  • id (basestring) – Application’s Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

applications

class Applications[source]

Cisco DNA Center Applications API (version: 2.1.2).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications(application_health=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of applications for a specific site, a device, or a client device’s MAC address.

Parameters:
  • site_id (basestring) – Assurance site UUID value (Cannot be submitted together with deviceId and clientMac).

  • device_id (basestring) – Assurance device UUID value (Cannot be submitted together with siteId and clientMac).

  • mac_address (basestring) – Client device’s MAC address (Cannot be submitted together with siteId and deviceId).

  • start_time (int) – Starting epoch time in milliseconds of time window.

  • end_time (int) – Ending epoch time in milliseconds of time window.

  • application_health (basestring) – Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only).

  • offset (int) – The offset of the first application in the returned data (optionally used with siteId only).

  • limit (int) – The max number of application entries in returned data [1, 1000] (optionally used with siteId only).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 2.1.2).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Client health data is required.

  • mac_address (basestring) – MAC Address of the client.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 2.1.2).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs.

Parameters:
  • commands (list) – CommandRunnerDTO’s commands (list of strings).

  • description (string) – CommandRunnerDTO’s description.

  • deviceUuids (list) – CommandRunnerDTO’s deviceUuids (list of strings).

  • name (string) – CommandRunnerDTO’s name.

  • timeout (number) – CommandRunnerDTO’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_archive

class ConfigurationArchive[source]

Cisco DNA Center Configuration Archive API (version: 2.1.2).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations(headers=None, **request_parameters)[source]

Export Device configurations to an encrypted zip file.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 2.1.2).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, software_type=None, software_version=None, headers=None, **request_parameters)[source]

List the templates available.

Parameters:
  • project_id (basestring) – projectId query parameter.

  • software_type (basestring) – softwareType query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • product_family (basestring) – productFamily query parameter.

  • product_series (basestring) – productSeries query parameter.

  • product_type (basestring) – productType query parameter.

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, headers=None, **request_parameters)[source]

Returns the projects in the system.

Parameters:
  • name (basestring) – Name of project to be searched.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploys a template.

Parameters:
  • forcePushTemplate (boolean) – TemplateDeploymentInfo’s forcePushTemplate.

  • isComposite (boolean) – TemplateDeploymentInfo’s isComposite.

  • mainTemplateId (string) – TemplateDeploymentInfo’s mainTemplateId.

  • memberTemplateDeploymentInfo (list) – TemplateDeploymentInfo’s memberTemplateDeploymentInfo (list of any objects).

  • targetInfo (list) – TemplateDeploymentInfo’s targetInfo (list of objects).

  • templateId (string) – TemplateDeploymentInfo’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Versioning for the current contents of the template.

Parameters:
  • comments (string) – TemplateVersionRequestDTO’s comments.

  • templateId (string) – TemplateVersionRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Returns details of the specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • latest_version (bool) – latestVersion query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing project.

Parameters:
  • createTime (number) – ProjectDTO’s createTime.

  • description (string) – ProjectDTO’s description.

  • id (string) – ProjectDTO’s id.

  • lastUpdateTime (number) – ProjectDTO’s lastUpdateTime.

  • name (string) – ProjectDTO’s name.

  • tags (list) – ProjectDTO’s tags (list of string, objects).

  • templates – Part of the JSON serializable Python object to send in the body of the Request.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

Returns the status of a deployed template.

Parameters:
  • deployment_id (basestring) – deploymentId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_template(template_id, headers=None, **request_parameters)[source]

Deletes an existing template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Returns the versions of a specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_project(project_id, headers=None, **request_parameters)[source]

Deletes an existing Project.

Parameters:
  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(params=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Previews an existing template.

Parameters:
  • params (object) – TemplatePreviewRequestDTO’s params.

  • templateId (string) – TemplatePreviewRequestDTO’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new template.

Parameters:
  • author (string) – TemplateDTO’s author.

  • composite (boolean) – TemplateDTO’s composite.

  • containingTemplates (list) – TemplateDTO’s containingTemplates (list of objects).

  • createTime (number) – TemplateDTO’s createTime.

  • description (string) – TemplateDTO’s description.

  • deviceTypes (list) – TemplateDTO’s deviceTypes (list of objects).

  • failurePolicy (string) – TemplateDTO’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – TemplateDTO’s id.

  • lastUpdateTime (number) – TemplateDTO’s lastUpdateTime.

  • name (string) – TemplateDTO’s name.

  • parentTemplateId (string) – TemplateDTO’s parentTemplateId.

  • projectId (string) – TemplateDTO’s projectId.

  • projectName (string) – TemplateDTO’s projectName.

  • rollbackTemplateContent (string) – TemplateDTO’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – TemplateDTO’s rollbackTemplateParams (list of objects).

  • softwareType (string) – TemplateDTO’s softwareType.

  • softwareVariant (string) – TemplateDTO’s softwareVariant.

  • softwareVersion (string) – TemplateDTO’s softwareVersion.

  • tags (list) – TemplateDTO’s tags (list of string, objects).

  • templateContent (string) – TemplateDTO’s templateContent.

  • templateParams (list) – TemplateDTO’s templateParams (list of objects).

  • version (string) – TemplateDTO’s version.

  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 2.1.2).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow.

Parameters:
  • deviceIdList (list) – UnclaimRequest’s deviceIdList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • name (basestring) – Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account.

Parameters:
  • domain (basestring) – Smart Account Domain.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count.

Parameters:
  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Parameters:
  • _id (string) – Workflow’s _id.

  • addToInventory (boolean) – Workflow’s addToInventory.

  • addedOn (number) – Workflow’s addedOn.

  • configId (string) – Workflow’s configId.

  • currTaskIdx (number) – Workflow’s currTaskIdx.

  • description (string) – Workflow’s description.

  • endTime (number) – Workflow’s endTime.

  • execTime (number) – Workflow’s execTime.

  • imageId (string) – Workflow’s imageId.

  • instanceType (string) – Workflow’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (number) – Workflow’s lastupdateOn.

  • name (string) – Workflow’s name.

  • startTime (number) – Workflow’s startTime.

  • state (string) – Workflow’s state.

  • tasks (list) – Workflow’s tasks (list of objects).

  • tenantId (string) – Workflow’s tenantId.

  • type (string) – Workflow’s type.

  • useState (string) – Workflow’s useState.

  • version (number) – Workflow’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings.

Parameters:
  • _id (string) – Settings’s _id.

  • aaaCredentials (object) – Settings’s aaaCredentials.

  • acceptEula (boolean) – Settings’s acceptEula.

  • defaultProfile (object) – Settings’s defaultProfile.

  • savaMappingList (list) – Settings’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Settings’s taskTimeOuts.

  • tenantId (string) – Settings’s tenantId.

  • version (number) – Settings’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state.

Parameters:
  • deviceResetList (list) – ResetRequest’s deviceResetList (list of objects).

  • projectId (string) – ResetRequest’s projectId.

  • workflowId (string) – ResetRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated lost of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • type (basestring, list, set, tuple) – Workflow Type.

  • name (basestring, list, set, tuple) – Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices.

Parameters:
  • autoSyncPeriod (number) – SAVAMapping’s autoSyncPeriod.

  • ccoUser (string) – SAVAMapping’s ccoUser.

  • expiry (number) – SAVAMapping’s expiry.

  • lastSync (number) – SAVAMapping’s lastSync.

  • profile (object) – SAVAMapping’s profile.

  • smartAccountId (string) – SAVAMapping’s smartAccountId.

  • syncResult (object) – SAVAMapping’s syncResult.

  • syncResultStr (string) – SAVAMapping’s syncResultStr.

  • syncStartTime (number) – SAVAMapping’s syncStartTime.

  • syncStatus (string) – SAVAMapping’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – SAVAMapping’s tenantId.

  • token (string) – SAVAMapping’s token.

  • virtualAccountId (string) – SAVAMapping’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration.

Parameters:
  • deviceId (string) – SiteProvisionRequest’s deviceId.

  • siteId (string) – SiteProvisionRequest’s siteId.

  • type (string) – SiteProvisionRequest’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination.

Parameters:
  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database.

Parameters:
  • _id (string) – Device’s _id.

  • deviceInfo (object) – Device’s deviceInfo.

  • runSummaryList (list) – Device’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device’s systemResetWorkflow.

  • systemWorkflow (object) – Device’s systemWorkflow.

  • tenantId (string) – Device’s tenantId.

  • version (number) – Device’s version.

  • workflow (object) – Device’s workflow.

  • workflowParameters (object) – Device’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow.

Parameters:
  • configFileUrl (string) – ClaimDeviceRequest’s configFileUrl.

  • configId (string) – ClaimDeviceRequest’s configId.

  • deviceClaimList (list) – ClaimDeviceRequest’s deviceClaimList (list of objects).

  • fileServiceId (string) – ClaimDeviceRequest’s fileServiceId.

  • imageId (string) – ClaimDeviceRequest’s imageId.

  • imageUrl (string) – ClaimDeviceRequest’s imageUrl.

  • populateInventory (boolean) – ClaimDeviceRequest’s populateInventory.

  • projectId (string) – ClaimDeviceRequest’s projectId.

  • workflowId (string) – ClaimDeviceRequest’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – Limits number of results.

  • offset (int) – Index of first result.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • serial_number (basestring, list, set, tuple) – Device Serial Number.

  • state (basestring, list, set, tuple) – Device State.

  • onb_state (basestring, list, set, tuple) – Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – Device Connection Manager State.

  • name (basestring, list, set, tuple) – Device Name.

  • pid (basestring, list, set, tuple) – Device ProductId.

  • source (basestring, list, set, tuple) – Device Source.

  • project_id (basestring, list, set, tuple) – Device Project Id.

  • workflow_id (basestring, list, set, tuple) – Device Workflow Id.

  • project_name (basestring, list, set, tuple) – Device Project Name.

  • workflow_name (basestring, list, set, tuple) – Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – Device Virtual Account.

  • last_contact (bool) – Device Has Contacted lastContact > 0.

  • mac_address (basestring) – Device Mac Address.

  • hostname (basestring) – Device Hostname.

  • site_name (basestring) – Device Site Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter.

Parameters:
  • serial_number (basestring) – Device Serial Number.

  • sort (basestring, list, set, tuple) – Comma seperated list of fields to sort on.

  • sort_order (basestring) – Sort Order Ascending (asc) or Descending (des).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_replacement

class DeviceReplacement[source]

Cisco DNA Center Device Replacement API (version: 2.1.2).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

UnMarks device for replacement.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images.

Parameters:
  • faultyDeviceSerialNumber (string) – DeviceReplacementWorkflowDTO’s faultyDeviceSerialNumber.

  • replacementDeviceSerialNumber (string) – DeviceReplacementWorkflowDTO’s replacementDeviceSerialNumber.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Marks device for replacement.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)[source]

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family.

Parameters:
  • faulty_device_name (basestring) – Faulty Device Name.

  • faulty_device_platform (basestring) – Faulty Device Platform.

  • replacement_device_platform (basestring) – Replacement Device Platform.

  • faulty_device_serial_number (basestring) – Faulty Device Serial Number.

  • replacement_device_serial_number (basestring) – Replacement Device Serial Number.

  • replacement_status (basestring, list, set, tuple) – Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED].

  • family (basestring, list, set, tuple) – List of families[Routers, Switches and Hubs, AP].

  • sort_by (basestring) – SortBy this field. SortBy is mandatory when order is used.

  • sort_order (basestring) – Order on displayName[ASC,DESC].

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)[source]

Get replacement devices count.

Parameters:
  • replacement_status (basestring, list, set, tuple) – Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR].

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 2.1.2).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

threat_detail_count(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details count for the Rogue and aWIPS threats.

Parameters:
  • endTime (number) – endTime, property of the request body.

  • isNewThreat (boolean) – isNewThreat, property of the request body.

  • limit (number) – limit, property of the request body.

  • offset (number) – offset, property of the request body.

  • siteId (list) – Site Id, property of the request body (list of strings).

  • startTime (number) – startTime, property of the request body.

  • threatLevel (list) – Threat Level, property of the request body (list of strings).

  • threatType (list) – Threat Type, property of the request body (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_summary(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The Threat Summary for the Rogues and aWIPS.

Parameters:
  • endTime (number) – Threat Parameters’s endTime.

  • siteId (list) – Threat Parameters’s Site Id (list of strings).

  • startTime (number) – Threat Parameters’s startTime.

  • threatLevel (list) – Threat Parameters’s Threat Level (list of strings).

  • threatType (list) – Threat Parameters’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_details(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details for the Rogue and aWIPS threats.

Parameters:
  • endTime (number) – Threat Parameters’s endTime.

  • isNewThreat (boolean) – Threat Parameters’s isNewThreat.

  • limit (number) – Threat Parameters’s limit.

  • offset (number) – Threat Parameters’s offset.

  • siteId (list) – Threat Parameters’s Site Id (list of strings).

  • startTime (number) – Threat Parameters’s startTime.

  • threatLevel (list) – Threat Parameters’s Threat Level (list of strings).

  • threatType (list) – Threat Parameters’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET /dna/intent/api/v1/network-de vice?hostname=myhost.*&managementIpAddress=192.25.18..* If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters.

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs.

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – Vlan assocaited with sub-interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range.

Parameters:
  • device_id (basestring) – Device ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id.

Parameters:
  • id (basestring) – Device ID.

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name.

Parameters:
  • device_id (basestring) – Device ID.

  • name (basestring) – Interface name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id.

Parameters:
  • id (basestring) – Functional Capability UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID.

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input.

Parameters:
  • cliTransport (string) – InventoryDeviceInfo’s cliTransport.

  • computeDevice (boolean) – InventoryDeviceInfo’s computeDevice.

  • enablePassword (string) – InventoryDeviceInfo’s enablePassword.

  • extendedDiscoveryInfo (string) – InventoryDeviceInfo’s extendedDiscoveryInfo.

  • httpPassword (string) – InventoryDeviceInfo’s httpPassword.

  • httpPort (string) – InventoryDeviceInfo’s httpPort.

  • httpSecure (boolean) – InventoryDeviceInfo’s httpSecure.

  • httpUserName (string) – InventoryDeviceInfo’s httpUserName.

  • ipAddress (list) – InventoryDeviceInfo’s ipAddress (list of strings).

  • merakiOrgId (list) – InventoryDeviceInfo’s merakiOrgId (list of strings).

  • netconfPort (string) – InventoryDeviceInfo’s netconfPort.

  • password (string) – InventoryDeviceInfo’s password.

  • serialNumber (string) – InventoryDeviceInfo’s serialNumber.

  • snmpAuthPassphrase (string) – InventoryDeviceInfo’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryDeviceInfo’s snmpAuthProtocol.

  • snmpMode (string) – InventoryDeviceInfo’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryDeviceInfo’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryDeviceInfo’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryDeviceInfo’s snmpROCommunity.

  • snmpRWCommunity (string) – InventoryDeviceInfo’s snmpRWCommunity.

  • snmpRetry (number) – InventoryDeviceInfo’s snmpRetry.

  • snmpTimeout (number) – InventoryDeviceInfo’s snmpTimeout.

  • snmpUserName (string) – InventoryDeviceInfo’s snmpUserName.

  • snmpVersion (string) – InventoryDeviceInfo’s snmpVersion.

  • type (string) – InventoryDeviceInfo’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – InventoryDeviceInfo’s updateMgmtIPaddressList (list of objects).

  • userName (string) – InventoryDeviceInfo’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router.

Parameters:
  • id (string) – NetworkDeviceBriefNIO’s id.

  • role (string) – NetworkDeviceBriefNIO’s role.

  • roleSource (string) – NetworkDeviceBriefNIO’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID.

Parameters:
  • id (basestring) – Interface ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices.

Parameters:
  • device_id (basestring) – Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file.

Parameters:
  • deviceUuids (list) – ExportDeviceDTO’s deviceUuids (list of strings).

  • id (string) – ExportDeviceDTO’s id.

  • operationEnum (string) – ExportDeviceDTO’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – ExportDeviceDTO’s parameters (list of strings).

  • password (string) – ExportDeviceDTO’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces for specified device management IP address.

Parameters:
  • ip_address (basestring) – IP address of the interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address.

Parameters:
  • ip_address (basestring) – Device IP address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device.

Parameters:
  • device_id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number.

Parameters:
  • serial_number (basestring) – Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification.

Parameters:
  • serial_number (basestring) – Serial number of the device.

  • macaddress (basestring) – Mac addres of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID.

Parameters:
  • id (basestring) – Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=500, offset=1, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the device data is required.

  • search_by (basestring) – MAC Address or Device Name value or UUID of the network device.

  • identifier (basestring) – One of keywords : macAddress or uuid or nwDeviceName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services.

Parameters:
  • device_role (basestring) – The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP).

  • site_id (basestring) – Assurance site UUID value.

  • health (basestring) – The device overall health (One of POOR, FAIR, GOOD).

  • start_time (int) – UTC epoch time in milliseconds.

  • end_time (int) – UTC epoch time in miliseconds.

  • limit (int) – Max number of device entries in the response (default to 50. Max at 1000).

  • offset (int) – The offset of the first device in the returned data.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 2.1.2).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

update_snmp_write_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community.

Parameters:
  • comments (string) – SNMPv2WriteCommunityDTO’s comments.

  • credentialType (string) – SNMPv2WriteCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2WriteCommunityDTO’s description.

  • id (string) – SNMPv2WriteCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2WriteCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2WriteCommunityDTO’s instanceUuid.

  • writeCommunity (string) – SNMPv2WriteCommunityDTO’s writeCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential.

Parameters:
  • authPassword (string) – SNMPv3CredentialDTO’s authPassword.

  • authType (string) – SNMPv3CredentialDTO’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – SNMPv3CredentialDTO’s comments.

  • credentialType (string) – SNMPv3CredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv3CredentialDTO’s description.

  • id (string) – SNMPv3CredentialDTO’s id.

  • instanceTenantId (string) – SNMPv3CredentialDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv3CredentialDTO’s instanceUuid.

  • privacyPassword (string) – SNMPv3CredentialDTO’s privacyPassword.

  • privacyType (string) – SNMPv3CredentialDTO’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – SNMPv3CredentialDTO’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – SNMPv3CredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range.

Parameters:
  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community.

Parameters:
  • comments (string) – SNMPv2ReadCommunityDTO’s comments.

  • credentialType (string) – SNMPv2ReadCommunityDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – SNMPv2ReadCommunityDTO’s description.

  • id (string) – SNMPv2ReadCommunityDTO’s id.

  • instanceTenantId (string) – SNMPv2ReadCommunityDTO’s instanceTenantId.

  • instanceUuid (string) – SNMPv2ReadCommunityDTO’s instanceUuid.

  • readCommunity (string) – SNMPv2ReadCommunityDTO’s readCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, noAddNewDevice=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, reDiscovery=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters.

Parameters:
  • cdpLevel (number) – InventoryRequest’s cdpLevel.

  • discoveryType (string) – InventoryRequest’s discoveryType.

  • enablePasswordList (list) – InventoryRequest’s enablePasswordList (list of string, objects).

  • globalCredentialIdList (list) – InventoryRequest’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – InventoryRequest’s httpReadCredential.

  • httpWriteCredential (object) – InventoryRequest’s httpWriteCredential.

  • ipAddressList (string) – InventoryRequest’s ipAddressList.

  • ipFilterList (list) – InventoryRequest’s ipFilterList (list of string, objects).

  • lldpLevel (number) – InventoryRequest’s lldpLevel.

  • name (string) – InventoryRequest’s name.

  • netconfPort (string) – InventoryRequest’s netconfPort.

  • noAddNewDevice (boolean) – InventoryRequest’s noAddNewDevice.

  • parentDiscoveryId (string) – InventoryRequest’s parentDiscoveryId.

  • passwordList (list) – InventoryRequest’s passwordList (list of string, objects).

  • preferredMgmtIPMethod (string) – InventoryRequest’s preferredMgmtIPMethod.

  • protocolOrder (string) – InventoryRequest’s protocolOrder.

  • reDiscovery (boolean) – InventoryRequest’s reDiscovery.

  • retry (number) – InventoryRequest’s retry.

  • snmpAuthPassphrase (string) – InventoryRequest’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – InventoryRequest’s snmpAuthProtocol.

  • snmpMode (string) – InventoryRequest’s snmpMode.

  • snmpPrivPassphrase (string) – InventoryRequest’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – InventoryRequest’s snmpPrivProtocol.

  • snmpROCommunity (string) – InventoryRequest’s snmpROCommunity.

  • snmpROCommunityDesc (string) – InventoryRequest’s snmpROCommunityDesc.

  • snmpRWCommunity (string) – InventoryRequest’s snmpRWCommunity.

  • snmpRWCommunityDesc (string) – InventoryRequest’s snmpRWCommunityDesc.

  • snmpUserName (string) – InventoryRequest’s snmpUserName.

  • snmpVersion (string) – InventoryRequest’s snmpVersion.

  • timeout (number) – InventoryRequest’s timeout.

  • updateMgmtIp (boolean) – InventoryRequest’s updateMgmtIp.

  • userNameList (list) – InventoryRequest’s userNameList (list of string, objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id.

Parameters:
  • id (basestring) – Global Credential ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s).

Parameters:
  • siteUuids (list) – SitesInfoDTO’s siteUuids (list of strings).

  • global_credential_id (basestring) – Global credential Uuid.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential.

Parameters:
  • comments (string) – HTTPReadCredentialDTO’s comments.

  • credentialType (string) – HTTPReadCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPReadCredentialDTO’s description.

  • id (string) – HTTPReadCredentialDTO’s id.

  • instanceTenantId (string) – HTTPReadCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPReadCredentialDTO’s instanceUuid.

  • password (string) – HTTPReadCredentialDTO’s password.

  • port (number) – HTTPReadCredentialDTO’s port.

  • secure (boolean) – HTTPReadCredentialDTO’s secure.

  • username (string) – HTTPReadCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • start_index (int) – Start index.

  • records_to_return (int) – Number of records to return.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery.

Parameters:
  • attributeInfo (object) – DiscoveryNIO’s attributeInfo.

  • cdpLevel (number) – DiscoveryNIO’s cdpLevel.

  • deviceIds (string) – DiscoveryNIO’s deviceIds.

  • discoveryCondition (string) – DiscoveryNIO’s discoveryCondition.

  • discoveryStatus (string) – DiscoveryNIO’s discoveryStatus.

  • discoveryType (string) – DiscoveryNIO’s discoveryType.

  • enablePasswordList (string) – DiscoveryNIO’s enablePasswordList.

  • globalCredentialIdList (list) – DiscoveryNIO’s globalCredentialIdList (list of string, objects).

  • httpReadCredential (object) – DiscoveryNIO’s httpReadCredential.

  • httpWriteCredential (object) – DiscoveryNIO’s httpWriteCredential.

  • id (string) – DiscoveryNIO’s id.

  • ipAddressList (string) – DiscoveryNIO’s ipAddressList.

  • ipFilterList (string) – DiscoveryNIO’s ipFilterList.

  • isAutoCdp (boolean) – DiscoveryNIO’s isAutoCdp.

  • lldpLevel (number) – DiscoveryNIO’s lldpLevel.

  • name (string) – DiscoveryNIO’s name.

  • netconfPort (string) – DiscoveryNIO’s netconfPort.

  • numDevices (number) – DiscoveryNIO’s numDevices.

  • parentDiscoveryId (string) – DiscoveryNIO’s parentDiscoveryId.

  • passwordList (string) – DiscoveryNIO’s passwordList.

  • preferredMgmtIPMethod (string) – DiscoveryNIO’s preferredMgmtIPMethod.

  • protocolOrder (string) – DiscoveryNIO’s protocolOrder.

  • retryCount (number) – DiscoveryNIO’s retryCount.

  • snmpAuthPassphrase (string) – DiscoveryNIO’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – DiscoveryNIO’s snmpAuthProtocol.

  • snmpMode (string) – DiscoveryNIO’s snmpMode.

  • snmpPrivPassphrase (string) – DiscoveryNIO’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – DiscoveryNIO’s snmpPrivProtocol.

  • snmpRoCommunity (string) – DiscoveryNIO’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – DiscoveryNIO’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – DiscoveryNIO’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – DiscoveryNIO’s snmpRwCommunityDesc.

  • snmpUserName (string) – DiscoveryNIO’s snmpUserName.

  • timeOut (number) – DiscoveryNIO’s timeOut.

  • updateMgmtIp (boolean) – DiscoveryNIO’s updateMgmtIp.

  • userNameList (string) – DiscoveryNIO’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials.

Parameters:
  • comments (string) – NetconfCredentialDTO’s comments.

  • credentialType (string) – NetconfCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – NetconfCredentialDTO’s description.

  • id (string) – NetconfCredentialDTO’s id.

  • instanceTenantId (string) – NetconfCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – NetconfCredentialDTO’s instanceUuid.

  • netconfPort (string) – NetconfCredentialDTO’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials.

Parameters:
  • comments (string) – HTTPWriteCredentialDTO’s comments.

  • credentialType (string) – HTTPWriteCredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – HTTPWriteCredentialDTO’s description.

  • id (string) – HTTPWriteCredentialDTO’s id.

  • instanceTenantId (string) – HTTPWriteCredentialDTO’s instanceTenantId.

  • instanceUuid (string) – HTTPWriteCredentialDTO’s instanceUuid.

  • password (string) – HTTPWriteCredentialDTO’s password.

  • port (number) – HTTPWriteCredentialDTO’s port.

  • secure (boolean) – HTTPWriteCredentialDTO’s secure.

  • username (string) – HTTPWriteCredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them.

Parameters:
  • start_index (int) – Start index.

  • records_to_delete (int) – Number of records to delete.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID.

Parameters:
  • global_credential_id (basestring) – ID of global-credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials.

Parameters:
  • comments (string) – CLICredentialDTO’s comments.

  • credentialType (string) – CLICredentialDTO’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – CLICredentialDTO’s description.

  • enablePassword (string) – CLICredentialDTO’s enablePassword.

  • id (string) – CLICredentialDTO’s id.

  • instanceTenantId (string) – CLICredentialDTO’s instanceTenantId.

  • instanceUuid (string) – CLICredentialDTO’s instanceUuid.

  • password (string) – CLICredentialDTO’s password.

  • username (string) – CLICredentialDTO’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type.

Parameters:
  • credential_sub_type (basestring) – Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF.

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 2.1.2).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=' ', limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • offset (int) – The number of Registries to offset in the resultset whose default value 0.

  • limit (int) – The number of Registries to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – The registered EventId should be provided.

  • tags (basestring) – The registered Tags should be provided.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions.

Parameters:
  • subscriptions (basestring) – List of EventSubscriptionId’s for removal.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=10, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – List of subscriptions related to the respective eventIds.

  • offset (int) – The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter.

Parameters:
  • execution_id (basestring) – Execution ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=20, offset=None, order=None, severity=None, sort_by=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications.

Parameters:
  • event_ids (basestring) – The registered EventIds should be provided.

  • start_time (basestring) – StartTime .

  • end_time (basestring) – endTime .

  • category (basestring) – category .

  • type (basestring) – type .

  • severity (basestring) – severity .

  • domain (basestring) – domain .

  • sub_domain (basestring) – subDomain .

  • source (basestring) – source .

  • offset (int) – Offset whose default value 0.

  • limit (int) – Limit whose default value 10.

  • sort_by (basestring) – SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 2.1.2).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace.

Parameters:
  • name_space (basestring) – A listing of fileId’s.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId.

Parameters:
  • file_id (basestring) – File Identification number.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

itsm

class Itsm[source]

Cisco DNA Center ITSM API (version: 2.1.2).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)[source]

Used to retrieve the list of integration events that failed to create tickets in ITSM.

Parameters:
  • instance_id (basestring) – Instance Id of the failed event as in the Runtime Dashboard.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 2.1.2).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

issues(ai_driven=None, device_id=None, end_time=None, issue_status=None, mac_address=None, priority=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device’s MAC address.

Parameters:
  • start_time (int) – Starting epoch time in milliseconds of query time window.

  • end_time (int) – Ending epoch time in milliseconds of query time window.

  • site_id (basestring) – Assurance UUID value of the site in the issue content.

  • device_id (basestring) – Assurance UUID value of the device in the issue content.

  • mac_address (basestring) – Client’s device MAC address of the issue (format xx:xx:xx:xx:xx:xx).

  • priority (basestring) – The issue’s priority value (One of P1, P2, P3, or P4)(Use only when macAddress and deviceId are not provided).

  • ai_driven (basestring) – The issue’s AI driven value (Yes or No)(Use only when macAddress and deviceId are not provided).

  • issue_status (basestring) – The issue’s status value (One of ACTIVE, IGNORED, RESOLVED) (Use only when macAddress and deviceId are not provided).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 2.1.2).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool.

Parameters:
  • id (basestring) – global pool id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential.

Parameters:
  • id (basestring) – global credential id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details.

Parameters:
  • site_id (basestring) – Site id to get the network settings associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS).

Parameters:
  • sp_profile_name (basestring) – sp profile name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update SP profile.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS).

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential To Site .

Parameters:
  • cliId (string) – Cli Id, property of the request body.

  • httpRead (string) – Http Read, property of the request body.

  • httpWrite (string) – Http Write, property of the request body.

  • snmpV2ReadId (string) – Snmp V2 Read Id, property of the request body.

  • snmpV2WriteId (string) – Snmp V2 Write Id, property of the request body.

  • snmpV3Id (string) – Snmp V3 Id, property of the request body.

  • site_id (basestring) – site id to assign credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Settings, property of the request body.

  • site_id (basestring) – Site id to update the network settings which is associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create service provider profile(QOS).

Parameters:
  • settings (object) – settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool.

Parameters:
  • offset (basestring) – offset/starting row.

  • limit (basestring) – No of Global Pools to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details.

Parameters:
  • site_id (basestring) – Site id to retrieve the credential details associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Settings, property of the request body.

  • site_id (basestring) – Site id to which site details to associate with the network settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool.

Parameters:
  • settings (object) – Settings, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 2.1.2).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

Parameters:
  • periodic_refresh (bool) – Is analysis periodically refreshed?.

  • source_ip (basestring) – Source IP address.

  • dest_ip (basestring) – Destination IP adress.

  • source_port (basestring) – Source port.

  • dest_port (basestring) – Destination port.

  • gt_create_time (basestring) – Analyses requested after this time.

  • lt_create_time (basestring) – Analyses requested before this time.

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – Task ID.

  • last_update_time (basestring) – Last update time.

  • limit (basestring) – Number of resources returned.

  • offset (basestring) – Start index of resources returned (1-based).

  • order (basestring) – Order by this field.

  • sort_by (basestring) – Sort by this field.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id.

Parameters:
  • flow_analysis_id (basestring) – Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

Parameters:
  • controlPath (boolean) – FlowAnalysisRequest’s controlPath.

  • destIP (string) – FlowAnalysisRequest’s destIP.

  • destPort (string) – FlowAnalysisRequest’s destPort.

  • inclusions (list) – FlowAnalysisRequest’s inclusions (list of strings).

  • periodicRefresh (boolean) – FlowAnalysisRequest’s periodicRefresh.

  • protocol (string) – FlowAnalysisRequest’s protocol.

  • sourceIP (string) – FlowAnalysisRequest’s sourceIP.

  • sourcePort (string) – FlowAnalysisRequest’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sda

class Sda[source]

Cisco DNA Center SDA API (version: 2.1.2).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

delete_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_info(device_ipaddress, headers=None, **request_parameters)[source]

Get device info from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_info(fabric_name, headers=None, **request_parameters)[source]

Get SDA Fabric Info.

Parameters:
  • fabric_name (basestring) – Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric.

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_fabric(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_vn(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_role_in_sda_fabric(device_management_ip_address, headers=None, **request_parameters)[source]

Get device role in SDA Fabric.

Parameters:
  • device_management_ip_address (basestring) – Device Management IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_count(headers=None, **request_parameters)[source]

Get SDA Fabric Count.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sda_fabric(fabric_name, headers=None, **request_parameters)[source]

Delete SDA Fabric.

Parameters:
  • fabric_name (basestring) – Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_control_plane_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_ipaddress, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_access_point(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_ipaddress, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_site(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors

class Sensors[source]

Cisco DNA Center Sensors API (version: 2.1.2).

Wraps the DNA Center Sensors API and exposes the API as native Python methods that return native Python objects.

create_sensor_test_template(apCoverage=None, connection=None, modelVersion=None, name=None, ssids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID.

Parameters:
  • apCoverage (list) – Ap Coverage, property of the request body (list of objects).

  • connection (string) – Connection, property of the request body.

  • modelVersion (number) – modelVersion, property of the request body.

  • name (string) – Name, property of the request body.

  • ssids (list) – Ssids, property of the request body (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sensor_test(template_name=None, headers=None, **request_parameters)[source]

Intent API to delete an existing SENSOR test template.

Parameters:
  • template_name (basestring) – templateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

duplicate_sensor_test_template(newTemplateName=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to duplicate an existing SENSOR test template.

Parameters:
  • newTemplateName (string) – New Template Name, property of the request body.

  • templateName (string) – Template Name, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors(site_id=None, headers=None, **request_parameters)[source]

Intent API to get a list of SENSOR devices.

Parameters:
  • site_id (basestring) – siteId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_sensor_test_template(locationInfoList=None, schedule=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to deploy, schedule, or edit and existing SENSOR test template.

Parameters:
  • locationInfoList (list) – Location Info List, property of the request body (list of objects).

  • schedule (object) – Schedule, property of the request body.

  • templateName (string) – Template Name, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_now_sensor_test(templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to run a deployed SENSOR test.

Parameters:
  • templateName (string) – Template Name, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 2.1.2).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

API to get NFV network profile.

Parameters:
  • id (basestring) – ID of network profile to retrieve.

  • offset (basestring) – offset/starting row.

  • limit (basestring) – Number of profile to be retrieved.

  • name (basestring) – Name of network profile to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a NFV Network profile.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • id (basestring) – Id of the NFV profile to be updated.

  • name (basestring) – Name of the profile to be updated.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network profile for different NFV topologies.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • profileName (string) – Site Profile Name, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information.

Parameters:
  • device_ip (string) – Device Ip, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_nfv_profile(id, name=None, headers=None, **request_parameters)[source]

API to delete nfv network profile.

Parameters:
  • id (basestring) – Id of nfv network profile to delete. .

  • name (basestring) – Nameof nfv network profile to delete. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor .

Parameters:
  • provisioning (list) – Provisioning, property of the request body (list of objects).

  • siteProfile (list) – Site Profile, property of the request body (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address.

Parameters:
  • device_ip (basestring) – Device to which the provisioning detail has to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 2.1.2).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site.

Parameters:
  • device (list) – Device, property of the request body (list of objects).

  • site_id (basestring) – Site id to which site the device to assign.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Site Hierarchy data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site with area/building/floor with specified hierarchy.

Parameters:
  • name (basestring) – siteNameHierarchy (ex: global/groupName).

  • site_id (basestring) – Site id to which site details to retrieve.

  • type (basestring) – type (ex: area, building, floor).

  • offset (basestring) – offset/starting row.

  • limit (basestring) – Number of sites to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – Site id to retrieve site count.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId.

Parameters:
  • site_id (basestring) – Site id to which site details to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_membership(site_id, device_family=None, limit=None, offset=None, serial_number=None, headers=None, **request_parameters)[source]

Getting the site children details and device details.

Parameters:
  • site_id (basestring) – Site id to retrieve device associated with the site.

  • offset (basestring) – offset/starting row.

  • limit (basestring) – Number of sites to be retrieved.

  • device_family (basestring) – Device family name .

  • serial_number (basestring) – Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values.

Parameters:
  • site (object) – Site, property of the request body.

  • type (string) – Type, property of the request body. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – Site id to which site details to be updated.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 2.1.2).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order='asc', version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%”.

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED.

  • version (basestring) – software Image Version.

  • image_series (basestring) – image Series.

  • image_name (basestring) – image Name.

  • is_tagged_golden (bool) – is Tagged Golden.

  • is_cco_recommended (bool) – is recommended from cisco.com.

  • is_cco_latest (bool) – is latest from cisco.com.

  • created_time (int) – time in milliseconds (epoch format).

  • image_size_greater_than (int) – size in bytes.

  • image_size_lesser_than (int) – size in bytes.

  • sort_by (basestring) – sort results by this field.

  • sort_order (basestring) – sort order ‘asc’ or ‘des’. Default is asc.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – Third party Image check.

  • third_party_vendor (basestring) – Third Party Vendor.

  • third_party_image_family (basestring) – Third Party image family.

  • third_party_application_type (basestring) – Third Party Application Type.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

Parameters:
  • schedule_at (basestring) – Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – Custom Description (Optional).

  • schedule_origin (basestring) – Originator of this call (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash.

Parameters:
  • schedule_validate (bool) – scheduleValidate, validates data before schedule (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 2.1.2).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level='0', member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.

Parameters:
  • memberToTags (list) – TagMemberDTO’s memberToTags (list of objects).

  • memberType (string) – TagMemberDTO’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id.

Parameters:
  • description (string) – TagDTO’s description.

  • dynamicRules (list) – TagDTO’s dynamicRules (list of objects).

  • id (string) – TagDTO’s id.

  • instanceTenantId (string) – TagDTO’s instanceTenantId.

  • name (string) – TagDTO’s name.

  • systemTag (boolean) – TagDTO’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count.

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size in kilobytes(KB).

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id.

Parameters:
  • id (basestring) – Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_id (basestring) – TagMember id to be removed from tag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level='0', limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id.

Parameters:
  • id (basestring) – Tag ID.

  • member_type (basestring) – Entity type of the member. Possible values can be retrieved by using /tag/member/type API.

  • offset (basestring) – Used for pagination. It indicates the starting row number out of available member records.

  • limit (basestring) – Used to Number of maximum members to return in the result.

  • member_association_type (basestring) – Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria.

Parameters:
  • name (basestring) – Tag name is mandatory when filter operation is used.

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size in kilobytes(KB).

  • field (basestring) – Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.

  • sort_by (basestring) – Only supported attribute is name. SortyBy is mandatory when order is used.

  • order (basestring) – Available values are asc and des.

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 2.1.2).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid.

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – Index, minimum value is 0.

  • limit (int) – The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id.

Parameters:
  • task_id (basestring) – UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria.

Parameters:
  • start_time (basestring) – This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – Fetch tasks that contains this data.

  • error_code (basestring) – Fetch tasks that have this error code.

  • service_type (basestring) – Fetch tasks with this service type.

  • username (basestring) – Fetch tasks with this username.

  • progress (basestring) – Fetch tasks that contains this progress.

  • is_error (basestring) – Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – Fetch tasks that contains this failure reason.

  • parent_id (basestring) – Fetch tasks that have this parent Id.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – Sort results by this field.

  • order (basestring) – Sort order asc or dsc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 2.1.2).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType.

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID.

Parameters:
  • vlan_id (basestring) – Vlan Name for e.g Vlan1, Vlan23 etc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol.

Parameters:
  • topology_type (basestring) – Type of topology(OSPF,ISIS,etc).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

Parameters:
  • timestamp (basestring, int) – Epoch time(in milliseconds) when the Network health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 2.1.2).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 2.1.2).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles.

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites.

Parameters:
  • enableFabric (boolean) – enableFabric, property of the request body.

  • flexConnect (object) – Flex Connect Applicable for non fabric profile, property of the request body.

  • managedAPLocations (list) – Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body (list of strings).

  • ssidDetails (object) – SsidDetails, property of the request body.

  • ssidType (string) – SSID Type, property of the request body. Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s).

Parameters:
  • rf_profile_name (basestring) – rf-profile-name path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensor_test_results(end_time=None, site_id=None, start_time=None, test_failure_by='area', headers=None, **request_parameters)[source]

Intent API to get SENSOR test result summary.

Parameters:
  • site_id (basestring) – Assurance site UUID.

  • start_time (int) – The epoch time in milliseconds.

  • end_time (int) – The epoch time in milliseconds.

  • test_failure_by (basestring) – Obtain failure statistics group by “area”, “building”, or “floor”.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(enableBroadcastSSID=None, enableFastLane=None, enableMACFiltering=None, fastTransition=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID.

Parameters:
  • enableBroadcastSSID (boolean) – enableBroadcastSSID, property of the request body.

  • enableFastLane (boolean) – enableFastLane, property of the request body.

  • enableMACFiltering (boolean) – enableMACFiltering, property of the request body.

  • fastTransition (string) – Fast Transition, property of the request body. Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • name (string) – Enter SSID Name, property of the request body. Constraints: maxLength set to 32.

  • passphrase (string) – Pass Phrase (Only applicable for SSID with PERSONAL security level), property of the request body. Constraints: maxLength set to 63 and minLength set to 8.

  • radioPolicy (string) – Radio Policy, property of the request body. Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Security Level, property of the request body. Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • trafficType (string) – Traffic Type, property of the request body. Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile.

Parameters:
  • profile_name (basestring) – profileName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile.

Parameters:
  • channelWidth (string) – Channel Width, property of the request body.

  • defaultRfProfile (boolean) – defaultRfProfile, property of the request body.

  • enableBrownField (boolean) – enableBrownField, property of the request body.

  • enableCustom (boolean) – enableCustom, property of the request body.

  • enableRadioTypeA (boolean) – enableRadioTypeA, property of the request body.

  • enableRadioTypeB (boolean) – enableRadioTypeB, property of the request body.

  • name (string) – Name, property of the request body.

  • radioTypeAProperties (object) – Radio Type AProperties, property of the request body.

  • radioTypeBProperties (object) – Radio Type BProperties, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the SSID name to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID.

Parameters:
  • ssid_name (basestring) – Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless Access points.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided.

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

Parameters:
  • profileDetails (object) – Profile Details, property of the request body.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center.

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v2.2.1

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 2.2.1).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name.

Parameters:
  • offset (int) – offset query parameter. The offset of the first application to be returned.

  • limit (int) – limit query parameter. The maximum number of applications to be returned.

  • name (basestring) – name query parameter. Application’s name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id.

Parameters:
  • id (basestring) – id query parameter. Application’s Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id.

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

applications

class Applications[source]

Cisco DNA Center Applications API (version: 2.2.1).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications(application_health=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of applications for a specific site, a device, or a client device’s MAC address.

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac).

  • device_id (basestring) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac).

  • mac_address (basestring) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId).

  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window.

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window.

  • application_health (basestring) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only).

  • offset (int) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only).

  • limit (int) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 2.2.1).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time.

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

client_proximity(username, number_days=None, time_resolution=None, headers=None, **request_parameters)[source]

This intent API will provide client proximity information for a specific wireless user. Proximity is defined as presence on the same floor at the same time as the specified wireless user. The Proximity workflow requires the subscription to the following event (via the Event Notification workflow) prior to making this API call: NETWORK-CLIENTS-3-506 Client Proximity Report.

Parameters:
  • username (basestring) – username query parameter. Wireless client username for which proximity information is required.

  • number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days.

  • time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required.

  • mac_address (basestring) – macAddress query parameter. MAC Address of the client.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 2.2.1).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs.

Parameters:
  • commands (list) – Command Runner’s commands (list of strings).

  • description (string) – Command Runner’s description.

  • deviceUuids (list) – Command Runner’s deviceUuids (list of strings).

  • name (string) – Command Runner’s name.

  • timeout (integer) – Command Runner’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

compliance

class Compliance[source]

Cisco DNA Center Compliance API (version: 2.2.1).

Wraps the DNA Center Compliance API and exposes the API as native Python methods that return native Python objects.

compliance_details_of_device(device_uuid, category=None, compliance_type=None, diff_list=None, key=None, value=None, headers=None, **request_parameters)[source]

Return compliance detailed report for a device.

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • category (basestring) – category query parameter. complianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’.

  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’.

  • diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ].

  • key (basestring) – key query parameter. extended attribute key.

  • value (basestring) – value query parameter. extended attribute value.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_compliance_status(device_uuid, headers=None, **request_parameters)[source]

Return compliance status of a device.

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status_(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s).

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’.

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids.

  • offset (int) – offset query parameter. offset/starting row.

  • limit (int) – limit query parameter. Number of records to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s).

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’.

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids.

  • offset (int) – offset query parameter. offset/starting row.

  • limit (int) – limit query parameter. Number of records to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_compliance(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Run compliance check for device(s).

Parameters:
  • categories (list) – Compliance’s categories (list of strings).

  • deviceUuids (list) – Compliance’s deviceUuids (list of strings).

  • triggerFull (boolean) – Compliance’s triggerFull.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_archive

class ConfigurationArchive[source]

Cisco DNA Center Configuration Archive API (version: 2.2.1).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Export Device configurations to an encrypted zip file.

Parameters:
  • deviceId (list) – Configuration Archive’s deviceId (list of strings).

  • password (string) – Configuration Archive’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 2.2.1).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

get_projects(name=None, headers=None, **request_parameters)[source]

Returns the projects in the system.

Parameters:
  • name (basestring) – name query parameter. Name of project to be searched.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing project.

Parameters:
  • createTime (integer) – Configuration Templates’s createTime.

  • description (string) – Configuration Templates’s description.

  • id (string) – Configuration Templates’s id.

  • lastUpdateTime (integer) – Configuration Templates’s lastUpdateTime.

  • name (string) – Configuration Templates’s name.

  • tags (list) – Configuration Templates’s tags (list of strings).

  • templates (object) – Configuration Templates’s templates.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new project.

Parameters:
  • createTime (integer) – Configuration Templates’s createTime.

  • description (string) – Configuration Templates’s description.

  • id (string) – Configuration Templates’s id.

  • lastUpdateTime (integer) – Configuration Templates’s lastUpdateTime.

  • name (string) – Configuration Templates’s name.

  • tags (list) – Configuration Templates’s tags (list of strings).

  • templates (object) – Configuration Templates’s templates.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, software_type=None, software_version=None, headers=None, **request_parameters)[source]

List the templates available.

Parameters:
  • project_id (basestring) – projectId query parameter.

  • software_type (basestring) – softwareType query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • product_family (basestring) – productFamily query parameter.

  • product_series (basestring) – productSeries query parameter.

  • product_type (basestring) – productType query parameter.

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing template.

Parameters:
  • author (string) – Configuration Templates’s author.

  • composite (boolean) – Configuration Templates’s composite.

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s createTime.

  • description (string) – Configuration Templates’s description.

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s id.

  • lastUpdateTime (integer) – Configuration Templates’s lastUpdateTime.

  • name (string) – Configuration Templates’s name.

  • parentTemplateId (string) – Configuration Templates’s parentTemplateId.

  • projectId (string) – Configuration Templates’s projectId.

  • projectName (string) – Configuration Templates’s projectName.

  • rollbackTemplateContent (string) – Configuration Templates’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s softwareType.

  • softwareVariant (string) – Configuration Templates’s softwareVariant.

  • softwareVersion (string) – Configuration Templates’s softwareVersion.

  • tags (list) – Configuration Templates’s tags (list of strings).

  • templateContent (string) – Configuration Templates’s templateContent.

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • version (string) – Configuration Templates’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploys a template.

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s isComposite.

  • mainTemplateId (string) – Configuration Templates’s mainTemplateId.

  • memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of strings).

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Versioning for the current contents of the template.

Parameters:
  • comments (string) – Configuration Templates’s comments.

  • templateId (string) – Configuration Templates’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Returns details of the specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • latest_version (bool) – latestVersion query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_template(template_id, headers=None, **request_parameters)[source]

Deletes an existing template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

Returns the status of a deployed template.

Parameters:
  • deployment_id (basestring) – deploymentId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Returns the versions of a specified template.

Parameters:
  • template_id (basestring) – templateId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_project(project_id, headers=None, **request_parameters)[source]

Deletes an existing Project.

Parameters:
  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(params=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Previews an existing template.

Parameters:
  • params (object) – Configuration Templates’s params.

  • templateId (string) – Configuration Templates’s templateId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, description=None, deviceTypes=None, failurePolicy=None, id=None, lastUpdateTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new template.

Parameters:
  • author (string) – Configuration Templates’s author.

  • composite (boolean) – Configuration Templates’s composite.

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s createTime.

  • description (string) – Configuration Templates’s description.

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s failurePolicy. Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s id.

  • lastUpdateTime (integer) – Configuration Templates’s lastUpdateTime.

  • name (string) – Configuration Templates’s name.

  • parentTemplateId (string) – Configuration Templates’s parentTemplateId.

  • projectId (string) – Configuration Templates’s projectId.

  • projectName (string) – Configuration Templates’s projectName.

  • rollbackTemplateContent (string) – Configuration Templates’s rollbackTemplateContent.

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s softwareType.

  • softwareVariant (string) – Configuration Templates’s softwareVariant.

  • softwareVersion (string) – Configuration Templates’s softwareVersion.

  • tags (list) – Configuration Templates’s tags (list of strings).

  • templateContent (string) – Configuration Templates’s templateContent.

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • version (string) – Configuration Templates’s version.

  • project_id (basestring) – projectId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 2.2.1).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP.

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain.

  • name (basestring) – name path parameter. Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, dayZeroConfig=None, dayZeroConfigPreview=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database.

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • dayZeroConfig (object) – Device Onboarding (PnP)’s dayZeroConfig.

  • dayZeroConfigPreview (object) – Device Onboarding (PnP)’s dayZeroConfigPreview.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (number) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow.

Parameters:
  • deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info.

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile.

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(_id=None, dayZeroConfig=None, dayZeroConfigPreview=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk.

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • dayZeroConfig (object) – Device Onboarding (PnP)’s dayZeroConfig.

  • dayZeroConfigPreview (object) – Device Onboarding (PnP)’s dayZeroConfigPreview.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (number) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information.

Parameters:
  • domain (basestring) – domain query parameter. Smart Account Domain.

  • name (basestring) – name query parameter. Virtual Account Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow.

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms.

Parameters:
  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account.

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count.

Parameters:
  • name (basestring, list, set, tuple) – name query parameter. Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings.

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • aaaCredentials (object) – Device Onboarding (PnP)’s aaaCredentials.

  • acceptEula (boolean) – Device Onboarding (PnP)’s acceptEula.

  • defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

  • savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Device Onboarding (PnP)’s taskTimeOuts.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – limit query parameter. Limits number of results.

  • offset (int) – offset query parameter. Index of first result.

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on.

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des).

  • type (basestring, list, set, tuple) – type query parameter. Workflow Type.

  • name (basestring, list, set, tuple) – name query parameter. Workflow Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state.

Parameters:
  • deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices.

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration.

Parameters:
  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow.

Parameters:
  • configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

  • fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

  • populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination.

Parameters:
  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number.

  • state (basestring, list, set, tuple) – state query parameter. Device State.

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State.

  • name (basestring, list, set, tuple) – name query parameter. Device Name.

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId.

  • source (basestring, list, set, tuple) – source query parameter. Device Source.

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id.

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id.

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name.

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account.

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint.

Parameters:
  • limit (int) – limit query parameter. Limits number of results.

  • offset (int) – offset query parameter. Index of first result.

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on.

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des).

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number.

  • state (basestring, list, set, tuple) – state query parameter. Device State.

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State.

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State.

  • name (basestring, list, set, tuple) – name query parameter. Device Name.

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId.

  • source (basestring, list, set, tuple) – source query parameter. Device Source.

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id.

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id.

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name.

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name.

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account.

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account.

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0.

  • mac_address (basestring) – macAddress query parameter. Device Mac Address.

  • hostname (basestring) – hostname query parameter. Device Hostname.

  • site_name (basestring) – siteName query parameter. Device Site Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(_id=None, dayZeroConfig=None, dayZeroConfigPreview=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database.

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • dayZeroConfig (object) – Device Onboarding (PnP)’s dayZeroConfig.

  • dayZeroConfigPreview (object) – Device Onboarding (PnP)’s dayZeroConfigPreview.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (number) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter.

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Device Serial Number.

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on.

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_replacement

class DeviceReplacement[source]

Cisco DNA Center Device Replacement API (version: 2.2.1).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images.

Parameters:
  • faultyDeviceSerialNumber (string) – Device Replacement’s faultyDeviceSerialNumber.

  • replacementDeviceSerialNumber (string) – Device Replacement’s replacementDeviceSerialNumber.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)[source]

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family.

Parameters:
  • faulty_device_name (basestring) – faultyDeviceName query parameter. Faulty Device Name.

  • faulty_device_platform (basestring) – faultyDevicePlatform query parameter. Faulty Device Platform.

  • replacement_device_platform (basestring) – replacementDevicePlatform query parameter. Replacement Device Platform.

  • faulty_device_serial_number (basestring) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number.

  • replacement_device_serial_number (basestring) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number.

  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED].

  • family (basestring, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP].

  • sort_by (basestring) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used.

  • sort_order (basestring) – sortOrder query parameter. Order on displayName[ASC,DESC].

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

UnMarks device for replacement.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Marks device for replacement.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)[source]

Get replacement devices count.

Parameters:
  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR].

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 2.2.1).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

threat_detail_count(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details count for the Rogue and aWIPS threats.

Parameters:
  • endTime (integer) – Devices’s endTime.

  • isNewThreat (boolean) – Devices’s isNewThreat.

  • limit (integer) – Devices’s limit.

  • offset (integer) – Devices’s offset.

  • siteId (list) – Devices’s siteId (list of strings).

  • startTime (integer) – Devices’s startTime.

  • threatLevel (list) – Devices’s threatLevel (list of strings).

  • threatType (list) – Devices’s threatType (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_summary(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The Threat Summary for the Rogues and aWIPS.

Parameters:
  • endTime (integer) – Devices’s endTime.

  • siteId (list) – Devices’s siteId (list of strings).

  • startTime (integer) – Devices’s startTime.

  • threatLevel (list) – Devices’s threatLevel (list of strings).

  • threatType (list) – Devices’s threatType (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_details(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details for the Rogue and aWIPS threats.

Parameters:
  • endTime (integer) – Devices’s endTime.

  • isNewThreat (boolean) – Devices’s isNewThreat.

  • limit (integer) – Devices’s limit.

  • offset (integer) – Devices’s offset.

  • siteId (list) – Devices’s siteId (list of strings).

  • startTime (integer) – Devices’s startTime.

  • threatLevel (list) – Devices’s threatLevel (list of strings).

  • threatType (list) – Devices’s threatType (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID.

Parameters:
  • id (basestring) – id path parameter. Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id.

Parameters:
  • id (basestring) – id path parameter. Device ID.

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_power_supply_fan_details_for_the_given_device(device_uuid, type, headers=None, **request_parameters)[source]

Return PowerSupply/ Fan details for the Given device.

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • type (basestring) – type query parameter. Type value should be PowerSupply or Fan.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs.

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – interfaceType query parameter. Vlan assocaited with sub-interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range.

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID.

  • start_index (int) – startIndex path parameter. Start index.

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device.

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(headers=None, **request_parameters)[source]

Get device list.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input.

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential.

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name.

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID.

  • name (basestring) – name query parameter. Interface name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device.

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id.

Parameters:
  • id (basestring) – id path parameter. Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id.

Parameters:
  • id (basestring) – id path parameter. Functional Capability UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id.

Parameters:
  • id (basestring) – id path parameter. Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID.

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard.

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details_(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device.

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device.

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID.

Parameters:
  • id (basestring) – id path parameter. Interface ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device.

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router.

Parameters:
  • id (string) – Devices’s id.

  • role (string) – Devices’s role.

  • roleSource (string) – Devices’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices.

Parameters:
  • device_id (basestring) – deviceId query parameter. Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list.

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification.

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Serial number of the device.

  • macaddress (basestring) – macaddress query parameter. Mac addres of the device.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces for specified device management IP address.

Parameters:
  • ip_address (basestring) – ipAddress path parameter. IP address of the interface.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file.

Parameters:
  • deviceUuids (list) – Devices’s deviceUuids (list of strings).

  • id (string) – Devices’s id.

  • operationEnum (string) – Devices’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – Devices’s parameters (list of strings).

  • password (string) – Devices’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address.

Parameters:
  • ip_address (basestring) – ipAddress path parameter. Device IP address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number.

Parameters:
  • serial_number (basestring) – serialNumber path parameter. Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id.

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range.

Parameters:
  • start_index (int) – startIndex path parameter. Start index.

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=None, offset=None, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID.

Parameters:
  • id (basestring) – id path parameter. Device ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the device data is required.

  • search_by (basestring) – searchBy query parameter. MAC Address or Device Name value or UUID of the network device.

  • identifier (basestring) – identifier query parameter. One of keywords : macAddress or uuid or nwDeviceName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services.

Parameters:
  • device_role (basestring) – deviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP).

  • site_id (basestring) – siteId query parameter. Assurance site UUID value.

  • health (basestring) – health query parameter. The device overall health (One of POOR, FAIR, GOOD).

  • start_time (int) – startTime query parameter. UTC epoch time in milliseconds.

  • end_time (int) – endTime query parameter. UTC epoch time in miliseconds.

  • limit (int) – limit query parameter. Max number of device entries in the response (default to 50. Max at 1000).

  • offset (int) – offset query parameter. The offset of the first device in the returned data.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 2.2.1).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials.

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • netconfPort (string) – Discovery’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials.

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • netconfPort (string) – Discovery’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range.

Parameters:
  • start_index (int) – startIndex path parameter. Start index.

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – id path parameter. Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – id path parameter. Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – id path parameter. Discovery ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials.

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials.

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery.

Parameters:
  • attributeInfo (object) – Discovery’s attributeInfo.

  • cdpLevel (integer) – Discovery’s cdpLevel.

  • deviceIds (string) – Discovery’s deviceIds.

  • discoveryCondition (string) – Discovery’s discoveryCondition.

  • discoveryStatus (string) – Discovery’s discoveryStatus.

  • discoveryType (string) – Discovery’s discoveryType.

  • enablePasswordList (string) – Discovery’s enablePasswordList.

  • globalCredentialIdList (list) – Discovery’s globalCredentialIdList (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • id (string) – Discovery’s id.

  • ipAddressList (string) – Discovery’s ipAddressList.

  • ipFilterList (string) – Discovery’s ipFilterList.

  • isAutoCdp (boolean) – Discovery’s isAutoCdp.

  • lldpLevel (integer) – Discovery’s lldpLevel.

  • name (string) – Discovery’s name.

  • netconfPort (string) – Discovery’s netconfPort.

  • numDevices (integer) – Discovery’s numDevices.

  • parentDiscoveryId (string) – Discovery’s parentDiscoveryId.

  • passwordList (string) – Discovery’s passwordList.

  • preferredMgmtIPMethod (string) – Discovery’s preferredMgmtIPMethod.

  • protocolOrder (string) – Discovery’s protocolOrder.

  • retryCount (integer) – Discovery’s retryCount.

  • snmpAuthPassphrase (string) – Discovery’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Discovery’s snmpAuthProtocol.

  • snmpMode (string) – Discovery’s snmpMode.

  • snmpPrivPassphrase (string) – Discovery’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Discovery’s snmpPrivProtocol.

  • snmpRoCommunity (string) – Discovery’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – Discovery’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – Discovery’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – Discovery’s snmpRwCommunityDesc.

  • snmpUserName (string) – Discovery’s snmpUserName.

  • timeOut (integer) – Discovery’s timeOut.

  • updateMgmtIp (boolean) – Discovery’s updateMgmtIp.

  • userNameList (string) – Discovery’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters.

Parameters:
  • cdpLevel (integer) – Discovery’s cdpLevel.

  • discoveryType (string) – Discovery’s discoveryType.

  • enablePasswordList (list) – Discovery’s enablePasswordList (list of strings).

  • globalCredentialIdList (list) – Discovery’s globalCredentialIdList (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • ipAddressList (string) – Discovery’s ipAddressList.

  • ipFilterList (list) – Discovery’s ipFilterList (list of strings).

  • lldpLevel (integer) – Discovery’s lldpLevel.

  • name (string) – Discovery’s name.

  • netconfPort (string) – Discovery’s netconfPort.

  • passwordList (list) – Discovery’s passwordList (list of strings).

  • preferredMgmtIPMethod (string) – Discovery’s preferredMgmtIPMethod.

  • protocolOrder (string) – Discovery’s protocolOrder.

  • retry (integer) – Discovery’s retry.

  • snmpAuthPassphrase (string) – Discovery’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Discovery’s snmpAuthProtocol.

  • snmpMode (string) – Discovery’s snmpMode.

  • snmpPrivPassphrase (string) – Discovery’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Discovery’s snmpPrivProtocol.

  • snmpROCommunity (string) – Discovery’s snmpROCommunity.

  • snmpROCommunityDesc (string) – Discovery’s snmpROCommunityDesc.

  • snmpRWCommunity (string) – Discovery’s snmpRWCommunity.

  • snmpRWCommunityDesc (string) – Discovery’s snmpRWCommunityDesc.

  • snmpUserName (string) – Discovery’s snmpUserName.

  • snmpVersion (string) – Discovery’s snmpVersion.

  • timeout (integer) – Discovery’s timeout.

  • userNameList (list) – Discovery’s userNameList (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id.

Parameters:
  • id (basestring) – id path parameter. Global Credential ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s).

Parameters:
  • siteUuids (list) – Discovery’s siteUuids (list of strings).

  • global_credential_id (basestring) – globalCredentialId path parameter. Global credential Uuid.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID.

Parameters:
  • global_credential_id (basestring) – globalCredentialId path parameter. ID of global-credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials.

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • enablePassword (string) – Discovery’s enablePassword.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential.

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • enablePassword (string) – Discovery’s enablePassword.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – id path parameter. Discovery ID.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP.

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – id path parameter. Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – id path parameter. Discovery ID.

  • start_index (int) – startIndex path parameter. Start index.

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them.

Parameters:
  • start_index (int) – startIndex path parameter. Start index.

  • records_to_delete (int) – recordsToDelete path parameter. Number of records to delete.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API.

Parameters:
  • id (basestring) – id path parameter. Discovery ID.

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type.

Parameters:
  • credential_sub_type (basestring) – credentialSubType query parameter. Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF.

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 2.2.1).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions.

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications.

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided.

  • start_time (int) – startTime query parameter. Start Time in milliseconds.

  • end_time (int) – endTime query parameter. End Time in milliseconds.

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain.

  • source (basestring) – source query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType.

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [SYSLOG].

  • name (basestring) – name query parameter. Name of the specific configuration.

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType.

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [EMAIL].

  • name (basestring) – name query parameter. Name of the specific configuration.

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of email Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids).

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – sortBy query parameter. SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Email Subscription Endpoint for list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Email Subscription Endpoint for list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided.

  • tags (basestring) – tags query parameter. The registered Tags should be provided.

  • offset (int) – offset query parameter. The number of Registries to offset in the resultset whose default value 0.

  • limit (int) – limit query parameter. The number of Registries to limit in the resultset whose default value 10.

  • sort_by (basestring) – sortBy query parameter. SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_summary(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_parent_only=None, is_system_events=None, name=None, parent_instance_id=None, severity=None, site_id=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Summary from the Event-Hub.

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID.

  • is_parent_only (bool) – isParentOnly query parameter. Parameter to filter parent only audit-logs.

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log.

  • name (basestring) – name query parameter. Audit Log notification event name.

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION.

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5.

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain.

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain.

  • source (basestring) – source query parameter. Audit Log notification’s event source.

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId.

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId.

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”.

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId.

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId.

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs.

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records).

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory).

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds.

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – sortBy query parameter. SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions.

Parameters:
  • subscriptions (basestring) – subscriptions query parameter. List of EventSubscriptionId’s for removal.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Syslog Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids).

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – sortBy query parameter. SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Syslog Subscription Endpoint for list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Syslog Subscription Endpoint for list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory.

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided.

  • tags (basestring) – tags query parameter. The registered Tags should be provided.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_eventartifacts(event_ids=None, limit=None, offset=None, order=None, search=None, sort_by=None, tags=None, headers=None, **request_parameters)[source]

Gets the list of artifacts based on provided offset and limit.

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of eventIds.

  • tags (basestring) – tags query parameter. Tags defined.

  • offset (int) – offset query parameter. Record start offset.

  • limit (int) – limit query parameter. # of records to return in result set.

  • sort_by (basestring) – sortBy query parameter. Sort by field.

  • order (basestring) – order query parameter. sorting order (asc/desc).

  • search (basestring) – search query parameter. findd matches in name, description, eventId, type, category.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=None, offset=None, order=None, severity=None, sort_by=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications.

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided.

  • start_time (int) – startTime query parameter. Start Time in milliseconds.

  • end_time (int) – endTime query parameter. End Time in milliseconds.

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain.

  • source (basestring) – source query parameter.

  • offset (int) – offset query parameter. Start Offset.

  • limit (int) – limit query parameter. # of records.

  • sort_by (basestring) – sortBy query parameter. Sort By column.

  • order (basestring) – order query parameter. Ascending/Descending order [asc/desc].

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, parent_instance_id=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Event instances from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID.

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log.

  • name (basestring) – name query parameter. Audit Log notification event name.

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION.

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5.

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain.

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain.

  • source (basestring) – source query parameter. Audit Log notification’s event source.

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId.

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId.

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”.

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId.

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId.

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs.

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records).

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page.

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory).

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory).

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes.

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Rest/Webhook Subscriptions’s based on provided offset and limit.

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids).

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0.

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10.

  • sort_by (basestring) – sortBy query parameter. SortBy field name.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Rest/Webhook Subscription Endpoint for list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Rest/Webhook Subscription Endpoint for list of registered events.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_parent_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Parent Audit Log Event instances from the Event-Hub .

Parameters:
  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log.

  • name (basestring) – name query parameter. Audit Log notification event name.

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION.

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5.

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain.

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain.

  • source (basestring) – source query parameter. Audit Log notification’s event source.

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId.

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId.

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”.

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId.

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId.

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs.

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records).

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page.

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory).

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory).

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes.

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

eventartifact_count(headers=None, **request_parameters)[source]

Get the count of registered event artifacts with provided eventIds or tags as mandatory.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType.

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [REST].

  • name (basestring) – name query parameter. Name of the specific configuration.

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter.

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 2.2.1).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace.

Parameters:
  • name_space (basestring) – nameSpace path parameter. A listing of fileId’s.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId.

Parameters:
  • file_id (basestring) – fileId path parameter. File Identification number.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

itsm

class Itsm[source]

Cisco DNA Center ITSM API (version: 2.2.1).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)[source]

Used to retrieve the list of integration events that failed to create tickets in ITSM.

Parameters:
  • instance_id (basestring) – instanceId query parameter. Instance Id of the failed event as in the Runtime Dashboard.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_cmdb_sync_status(date=None, status=None, headers=None, **request_parameters)[source]

This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter “status”,”date”.The supported values for status field are “Success”,”Failed”,”Unknown” and date field should be in “YYYY-MM- DD” format. By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response.

Parameters:
  • status (basestring) – status query parameter. Supported values are “Success”,”Failed” and “Unknown”. Providing other values will result in all the available sync job status.

  • date (basestring) – date query parameter. Provide date in “YYYY-MM-DD” format.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 2.2.1).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

issues(ai_driven=None, device_id=None, end_time=None, issue_status=None, mac_address=None, priority=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device’s MAC address.

Parameters:
  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of query time window.

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of query time window.

  • site_id (basestring) – siteId query parameter. Assurance UUID value of the site in the issue content.

  • device_id (basestring) – deviceId query parameter. Assurance UUID value of the device in the issue content.

  • mac_address (basestring) – macAddress query parameter. Client’s device MAC address of the issue (format xx:xx:xx:xx:xx:xx).

  • priority (basestring) – priority query parameter. The issue’s priority value (One of P1, P2, P3, or P4)(Use only when macAddress and deviceId are not provided).

  • ai_driven (basestring) – aiDriven query parameter. The issue’s AI driven value (Yes or No)(Use only when macAddress and deviceId are not provided).

  • issue_status (basestring) – issueStatus query parameter. The issue’s status value (One of ACTIVE, IGNORED, RESOLVED) (Use only when macAddress and deviceId are not provided).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 2.2.1).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool.

Parameters:
  • offset (basestring) – offset query parameter. offset/starting row.

  • limit (basestring) – limit query parameter. No of Global Pools to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool.

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool.

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool.

Parameters:
  • id (basestring) – id path parameter. global pool id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential.

Parameters:
  • id (basestring) – id path parameter. global credential id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details.

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to get the network settings associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_reserve_ip_subpool(limit=None, offset=None, site_id=None, headers=None, **request_parameters)[source]

API to get the ip subpool info.

Parameters:
  • site_id (basestring) – siteId query parameter. site id to get the reserve ip associated with the site.

  • offset (basestring) – offset query parameter. offset/starting row.

  • limit (basestring) – limit query parameter. No of Global Pools to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_reserve_ip_subpool(id, site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update ip subpool from the global pool.

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s ipv4DhcpServers (list of strings).

  • ipv4DnsServers (list) – Network Settings’s ipv4DnsServers (list of strings).

  • ipv6AddressSpace (boolean) – Network Settings’s ipv6AddressSpace.

  • ipv6DhcpServers (list) – Network Settings’s ipv6DhcpServers (list of strings).

  • ipv6DnsServers (list) – Network Settings’s ipv6DnsServers (list of strings).

  • ipv6GateWay (string) – Network Settings’s ipv6GateWay.

  • ipv6GlobalPool (string) – Network Settings’s ipv6GlobalPool.

  • ipv6Prefix (boolean) – Network Settings’s ipv6Prefix.

  • ipv6PrefixLength (integer) – Network Settings’s ipv6PrefixLength.

  • ipv6Subnet (string) – Network Settings’s ipv6Subnet.

  • ipv6TotalHost (integer) – Network Settings’s ipv6TotalHost.

  • name (string) – Network Settings’s name.

  • slaacSupport (boolean) – Network Settings’s slaacSupport.

  • site_id (basestring) – siteId path parameter. Site id of site to update sub pool.

  • id (basestring) – id query parameter. Id of subpool to be associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reserve_ip_subpool(site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv4GlobalPool=None, ipv4Prefix=None, ipv4PrefixLength=None, ipv4Subnet=None, ipv4TotalHost=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to reserve an ip subpool from the global pool.

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s ipv4DhcpServers (list of strings).

  • ipv4DnsServers (list) – Network Settings’s ipv4DnsServers (list of strings).

  • ipv4GateWay (string) – Network Settings’s ipv4GateWay.

  • ipv4GlobalPool (string) – Network Settings’s ipv4GlobalPool.

  • ipv4Prefix (boolean) – Network Settings’s ipv4Prefix.

  • ipv4PrefixLength (integer) – Network Settings’s ipv4PrefixLength.

  • ipv4Subnet (string) – Network Settings’s ipv4Subnet.

  • ipv4TotalHost (integer) – Network Settings’s ipv4TotalHost.

  • ipv6AddressSpace (boolean) – Network Settings’s ipv6AddressSpace.

  • ipv6DhcpServers (list) – Network Settings’s ipv6DhcpServers (list of strings).

  • ipv6DnsServers (list) – Network Settings’s ipv6DnsServers (list of strings).

  • ipv6GateWay (string) – Network Settings’s ipv6GateWay.

  • ipv6GlobalPool (string) – Network Settings’s ipv6GlobalPool.

  • ipv6Prefix (boolean) – Network Settings’s ipv6Prefix.

  • ipv6PrefixLength (integer) – Network Settings’s ipv6PrefixLength.

  • ipv6Subnet (string) – Network Settings’s ipv6Subnet.

  • ipv6TotalHost (integer) – Network Settings’s ipv6TotalHost.

  • name (string) – Network Settings’s name.

  • slaacSupport (boolean) – Network Settings’s slaacSupport.

  • type (string) – Network Settings’s type. Available values are ‘Generic’, ‘LAN’, ‘WAN’, ‘management’ and ‘service’.

  • site_id (basestring) – siteId path parameter. Site id to reserve the ip sub pool.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details.

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve the credential details associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials.

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials.

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS).

Parameters:
  • sp_profile_name (basestring) – sp-profile-name path parameter. sp profile name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS).

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update SP profile.

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create service provider profile(QOS).

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to update the network settings which is associated with the site.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP and DNS center server settings.

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to which site details to associate with the network settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential To Site .

Parameters:
  • cliId (string) – Network Settings’s cliId.

  • httpRead (string) – Network Settings’s httpRead.

  • httpWrite (string) – Network Settings’s httpWrite.

  • snmpV2ReadId (string) – Network Settings’s snmpV2ReadId.

  • snmpV2WriteId (string) – Network Settings’s snmpV2WriteId.

  • snmpV3Id (string) – Network Settings’s snmpV3Id.

  • site_id (basestring) – siteId path parameter. site id to assign credential.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

release_reserve_ip_subpool(id, headers=None, **request_parameters)[source]

API to delete the reserved ip subpool.

Parameters:
  • id (basestring) – id path parameter. Id of reserve ip subpool to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 2.2.1).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

Parameters:
  • periodic_refresh (bool) – periodicRefresh query parameter. Is analysis periodically refreshed?.

  • source_ip (basestring) – sourceIP query parameter. Source IP address.

  • dest_ip (basestring) – destIP query parameter. Destination IP adress.

  • source_port (basestring) – sourcePort query parameter. Source port.

  • dest_port (basestring) – destPort query parameter. Destination port.

  • gt_create_time (basestring) – gtCreateTime query parameter. Analyses requested after this time.

  • lt_create_time (basestring) – ltCreateTime query parameter. Analyses requested before this time.

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – taskId query parameter. Task ID.

  • last_update_time (basestring) – lastUpdateTime query parameter. Last update time.

  • limit (basestring) – limit query parameter. Number of resources returned.

  • offset (basestring) – offset query parameter. Start index of resources returned (1-based).

  • order (basestring) – order query parameter. Order by this field.

  • sort_by (basestring) – sortBy query parameter. Sort by this field.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

Parameters:
  • controlPath (boolean) – Path Trace’s controlPath.

  • destIP (string) – Path Trace’s destIP.

  • destPort (string) – Path Trace’s destPort.

  • inclusions (list) – Path Trace’s inclusions (list of strings).

  • periodicRefresh (boolean) – Path Trace’s periodicRefresh.

  • protocol (string) – Path Trace’s protocol.

  • sourceIP (string) – Path Trace’s sourceIP.

  • sourcePort (string) – Path Trace’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id.

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id.

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reports

class Reports[source]

Cisco DNA Center Reports API (version: 2.2.1).

Wraps the DNA Center Reports API and exposes the API as native Python methods that return native Python objects.

get_views_for_a_given_view_group(view_group_id, headers=None, **request_parameters)[source]

Gives a list of summary of all views in a viewgroup. Use “Get all view groups” API to get the viewGroupIds (required as a query param for this API) for available viewgroups.

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_view_details_for_a_given_view_group_and_view(view_group_id, view_id, headers=None, **request_parameters)[source]

Gives complete information of the view that is required to configure a report. Use “Get views for a given view group” API to get the viewIds (required as a query param for this API) for available views.

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup.

  • view_id (basestring) – viewId path parameter. view id of view.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Get scheduled report configuration by reportId.

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Delete a scheduled report configuration. Deletes the report executions also.

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_scheduled_reports(view_group_id=None, view_id=None, headers=None, **request_parameters)[source]

Get list of scheduled report configurations.

Parameters:
  • view_group_id (basestring) – viewGroupId query parameter. viewGroupId of viewgroup for report.

  • view_id (basestring) – viewId query parameter. viewId of view for report.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_schedule_a_report(deliveries=None, name=None, schedule=None, tags=None, view=None, viewGroupId=None, viewGroupVersion=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Schedule a report configuration. Use “Get view details for a given view group & view” API to get the metadata required to configure a report.

Parameters:
  • deliveries (list) – Reports’s deliveries (list of objects).

  • name (string) – Reports’s name.

  • schedule (object) – Reports’s schedule.

  • tags (list) – Reports’s tags (list of strings).

  • view (object) – Reports’s view.

  • viewGroupId (string) – Reports’s viewGroupId.

  • viewGroupVersion (string) – Reports’s viewGroupVersion.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_view_groups(headers=None, **request_parameters)[source]

Gives a list of summary of all view groups.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_execution_details_for_a_given_report(report_id, headers=None, **request_parameters)[source]

Get details of all executions for a given report.

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_report_content(execution_id, report_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header.

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report.

  • execution_id (basestring) – executionId path parameter. executionId of report execution.

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

sda

class Sda[source]

Cisco DNA Center SDA API (version: 2.2.1).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

get_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_access_point(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_info(device_ipaddress, headers=None, **request_parameters)[source]

Get device info from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_info(fabric_name, headers=None, **request_parameters)[source]

Get SDA Fabric Info.

Parameters:
  • fabric_name (basestring) – fabricName query parameter. Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_fabric(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sda_fabric(fabric_name, headers=None, **request_parameters)[source]

Delete SDA Fabric.

Parameters:
  • fabric_name (basestring) – fabricName query parameter. Fabric Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network.

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric.

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_vn(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Add default authentication profile in SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_site(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric.

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_count(headers=None, **request_parameters)[source]

Get SDA Fabric Count.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric.

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_role_in_sda_fabric(device_management_ip_address, headers=None, **request_parameters)[source]

Get device role in SDA Fabric.

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Device Management IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_ipaddress, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_ipaddress, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_control_plane_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric.

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

security_advisories

class SecurityAdvisories[source]

Cisco DNA Center Security Advisories API (version: 2.2.1).

Wraps the DNA Center Security Advisories API and exposes the API as native Python methods that return native Python objects.

get_advisories_summary(headers=None, **request_parameters)[source]

Retrieves summary of advisories on the network.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisories for a device.

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_list(headers=None, **request_parameters)[source]

Retrieves list of advisories on the network.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisory_ids_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisory IDs for a device.

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_per_advisory(advisory_id, headers=None, **request_parameters)[source]

Retrieves list of devices for an advisory.

Parameters:
  • advisory_id (basestring) – advisoryId path parameter. Advisory ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors

class Sensors[source]

Cisco DNA Center Sensors API (version: 2.2.1).

Wraps the DNA Center Sensors API and exposes the API as native Python methods that return native Python objects.

sensors(site_id=None, headers=None, **request_parameters)[source]

Intent API to get a list of SENSOR devices.

Parameters:
  • site_id (basestring) – siteId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sensor_test_template(apCoverage=None, connection=None, modelVersion=None, name=None, ssids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID.

Parameters:
  • apCoverage (list) – Sensors’s apCoverage (list of objects).

  • connection (string) – Sensors’s connection.

  • modelVersion (integer) – Sensors’s modelVersion.

  • name (string) – Sensors’s name.

  • ssids (list) – Sensors’s ssids (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sensor_test(template_name=None, headers=None, **request_parameters)[source]

Intent API to delete an existing SENSOR test template.

Parameters:
  • template_name (basestring) – templateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

duplicate_sensor_test_template(newTemplateName=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to duplicate an existing SENSOR test template.

Parameters:
  • newTemplateName (string) – Sensors’s newTemplateName.

  • templateName (string) – Sensors’s templateName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_sensor_test_template(locationInfoList=None, schedule=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to deploy, schedule, or edit and existing SENSOR test template.

Parameters:
  • locationInfoList (list) – Sensors’s locationInfoList (list of objects).

  • schedule (object) – Sensors’s schedule.

  • templateName (string) – Sensors’s templateName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_now_sensor_test(templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to run a deployed SENSOR test.

Parameters:
  • templateName (string) – Sensors’s templateName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 2.2.1).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

API to get NFV network profile.

Parameters:
  • id (basestring) – id path parameter. ID of network profile to retrieve.

  • offset (basestring) – offset query parameter. offset/starting row.

  • limit (basestring) – limit query parameter. Number of profile to be retrieved.

  • name (basestring) – name query parameter. Name of network profile to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a NFV Network profile.

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • id (basestring) – id path parameter. Id of the NFV profile to be updated.

  • name (basestring) – name query parameter. Name of the profile to be updated.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_nfv_profile(id, name=None, headers=None, **request_parameters)[source]

API to delete nfv network profile.

Parameters:
  • id (basestring) – id path parameter. Id of nfv network profile to delete. .

  • name (basestring) – name query parameter. Nameof nfv network profile to delete. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information.

Parameters:
  • device_ip (string) – Site Design’s device_ip.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor .

Parameters:
  • provisioning (list) – Site Design’s provisioning (list of objects).

  • siteProfile (list) – Site Design’s siteProfile (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network profile for different NFV topologies.

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • profileName (string) – Site Design’s profileName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address.

Parameters:
  • device_ip (basestring) – deviceIp query parameter. Device to which the provisioning detail has to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 2.2.1).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site.

Parameters:
  • device (list) – Sites’s device (list of objects).

  • site_id (basestring) – siteId path parameter. Site id to which site the device to assign.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites.

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site using siteNameHierarchy/siteId/type ,return all sites if these parameters are not given as input.

Parameters:
  • name (basestring) – name query parameter. siteNameHierarchy (ex: global/groupName).

  • site_id (basestring) – siteId query parameter. Site id to which site details to retrieve.

  • type (basestring) – type query parameter. type (ex: area, building, floor).

  • offset (basestring) – offset query parameter. offset/starting row.

  • limit (basestring) – limit query parameter. Number of sites to be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy.

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s type. Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve site count.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values.

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s type. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – siteId path parameter. Site id to which site details to be updated.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId.

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to which site details to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_membership(site_id, device_family=None, limit=None, offset=None, serial_number=None, headers=None, **request_parameters)[source]

Getting the site children details and device details.

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to retrieve device associated with the site.

  • offset (basestring) – offset query parameter. offset/starting row.

  • limit (basestring) – limit query parameter. Number of sites to be retrieved.

  • device_family (basestring) – deviceFamily query parameter. Device family name .

  • serial_number (basestring) – serialNumber query parameter. Device serial number.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 2.2.1).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order=None, version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%”.

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus query parameter. imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED.

  • version (basestring) – version query parameter. software Image Version.

  • image_series (basestring) – imageSeries query parameter. image Series.

  • image_name (basestring) – imageName query parameter. image Name.

  • is_tagged_golden (bool) – isTaggedGolden query parameter. is Tagged Golden.

  • is_cco_recommended (bool) – isCCORecommended query parameter. is recommended from cisco.com.

  • is_cco_latest (bool) – isCCOLatest query parameter. is latest from cisco.com.

  • created_time (int) – createdTime query parameter. time in milliseconds (epoch format).

  • image_size_greater_than (int) – imageSizeGreaterThan query parameter. size in bytes.

  • image_size_lesser_than (int) – imageSizeLesserThan query parameter. size in bytes.

  • sort_by (basestring) – sortBy query parameter. sort results by this field.

  • sort_order (basestring) – sortOrder query parameter. sort order ‘asc’ or ‘des’. Default is asc.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – isThirdParty query parameter. Third party Image check.

  • third_party_vendor (basestring) – thirdPartyVendor query parameter. Third Party Vendor.

  • third_party_image_family (basestring) – thirdPartyImageFamily query parameter. Third Party image family.

  • third_party_application_type (basestring) – thirdPartyApplicationType query parameter. Third Party Application Type.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

Parameters:
  • schedule_at (basestring) – scheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – scheduleDesc query parameter. Custom Description (Optional).

  • schedule_origin (basestring) – scheduleOrigin query parameter. Originator of this call (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash.

Parameters:
  • schedule_validate (bool) – scheduleValidate query parameter. scheduleValidate, validates data before schedule (Optional).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 2.2.1).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

get_tag_members_by_id(id, member_type, level=None, limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id.

Parameters:
  • id (basestring) – id path parameter. Tag ID.

  • member_type (basestring) – memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API.

  • offset (basestring) – offset query parameter. Used for pagination. It indicates the starting row number out of available member records.

  • limit (basestring) – limit query parameter. Used to Number of maximum members to return in the result.

  • member_association_type (basestring) – memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id.

Parameters:
  • id (basestring) – id path parameter. Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria.

Parameters:
  • name (basestring) – name query parameter. Tag name is mandatory when filter operation is used.

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB).

  • field (basestring) – field query parameter. Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.

  • sort_by (basestring) – sortBy query parameter. Only supported attribute is name. SortyBy is mandatory when order is used.

  • order (basestring) – order query parameter. Available values are asc and des.

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id.

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes.

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level=None, member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag.

Parameters:
  • id (basestring) – id path parameter. Tag ID.

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id.

Parameters:
  • id (basestring) – id path parameter. Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id.

Parameters:
  • id (basestring) – id path parameter. Tag ID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.

Parameters:
  • memberToTags (list) – Tag’s memberToTags (list of objects).

  • memberType (string) – Tag’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count.

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB).

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id.

Parameters:
  • id (basestring) – id path parameter. Tag ID.

  • member_id (basestring) – memberId path parameter. TagMember id to be removed from tag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 2.2.1).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count.

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – data query parameter. Fetch tasks that contains this data.

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code.

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type.

  • username (basestring) – username query parameter. Fetch tasks with this username.

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress.

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason.

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id.

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid.

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – offset path parameter. Index, minimum value is 0.

  • limit (int) – limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria.

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched.

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched.

  • data (basestring) – data query parameter. Fetch tasks that contains this data.

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code.

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type.

  • username (basestring) – username query parameter. Fetch tasks with this username.

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress.

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false.

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason.

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – sortBy query parameter. Sort results by this field.

  • order (basestring) – order query parameter. Sort order asc or dsc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id.

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 2.2.1).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType.

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID.

Parameters:
  • vlan_id (basestring) – vlanID path parameter. Vlan Name for e.g Vlan1, Vlan23 etc.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol.

Parameters:
  • topology_type (basestring) – topologyType path parameter. Type of topology(OSPF,ISIS,etc).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Network health data is required.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 2.2.1).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 2.2.1).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles.

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile.

Parameters:
  • channelWidth (string) – Wireless’s channelWidth.

  • defaultRfProfile (boolean) – Wireless’s defaultRfProfile.

  • enableBrownField (boolean) – Wireless’s enableBrownField.

  • enableCustom (boolean) – Wireless’s enableCustom.

  • enableRadioTypeA (boolean) – Wireless’s enableRadioTypeA.

  • enableRadioTypeB (boolean) – Wireless’s enableRadioTypeB.

  • name (string) – Wireless’s name.

  • radioTypeAProperties (object) – Wireless’s radioTypeAProperties.

  • radioTypeBProperties (object) – Wireless’s radioTypeBProperties.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites.

Parameters:
  • enableFabric (boolean) – Wireless’s enableFabric.

  • flexConnect (object) – Wireless’s flexConnect.

  • managedAPLocations (list) – Wireless’s managedAPLocations (list of strings).

  • ssidDetails (object) – Wireless’s ssidDetails.

  • ssidType (string) – Wireless’s ssidType. Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s).

Parameters:
  • rf_profile_name (basestring) – rf-profile-name path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID.

Parameters:
  • ssid_name (basestring) – ssidName query parameter. Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(enableBroadcastSSID=None, enableFastLane=None, enableMACFiltering=None, fastTransition=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID.

Parameters:
  • enableBroadcastSSID (boolean) – Wireless’s enableBroadcastSSID.

  • enableFastLane (boolean) – Wireless’s enableFastLane.

  • enableMACFiltering (boolean) – Wireless’s enableMACFiltering.

  • fastTransition (string) – Wireless’s fastTransition. Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • name (string) – Wireless’s name.

  • passphrase (string) – Wireless’s passphrase.

  • radioPolicy (string) – Wireless’s radioPolicy. Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Wireless’s securityLevel. Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • trafficType (string) – Wireless’s trafficType. Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile.

Parameters:
  • profile_name (basestring) – profileName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensor_test_results(end_time=None, site_id=None, start_time=None, test_failure_by=None, headers=None, **request_parameters)[source]

Intent API to get SENSOR test result summary.

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID.

  • start_time (int) – startTime query parameter. The epoch time in milliseconds.

  • end_time (int) – endTime query parameter. The epoch time in milliseconds.

  • test_failure_by (basestring) – testFailureBy query parameter. Obtain failure statistics group by “area”, “building”, or “floor”.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID.

Parameters:
  • ssid_name (basestring) – ssidName path parameter. Enter the SSID name to be deleted.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided.

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless Access points.

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center.

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v2.2.2.3

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 2.2.2.3).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_application_sets(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id .

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id .

Parameters:
  • id (basestring) – id query parameter. Application’s Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name .

Parameters:
  • offset (int) – offset query parameter. The offset of the first application to be returned .

  • limit (int) – limit query parameter. The maximum number of applications to be returned .

  • name (basestring) – name query parameter. Application’s name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

applications

class Applications[source]

Cisco DNA Center Applications API (version: 2.2.2.3).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications(application_health=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of applications for a specific site, a device, or a client device’s MAC address. .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac) .

  • device_id (basestring) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac) .

  • mac_address (basestring) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId) .

  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window .

  • application_health (basestring) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) .

  • offset (int) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) .

  • limit (int) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

authentication_management

class AuthenticationManagement[source]

Cisco DNA Center Authentication Management API (version: 2.2.2.3).

Wraps the DNA Center Authentication Management API and exposes the API as native Python methods that return native Python objects.

import_certificate(multipart_fields, multipart_monitor_callback, list_of_users=None, pk_password=None, headers=None, **request_parameters)[source]

This method is used to upload a certificate. Upload the files to the certFileUpload and pkFileUpload form data fields .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • pk_password (basestring) – pkPassword query parameter. Private Key Passsword .

  • list_of_users (basestring, list, set, tuple) – listOfUsers query parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_certificate_p12(multipart_fields, multipart_monitor_callback, list_of_users=None, p12_password=None, pk_password=None, headers=None, **request_parameters)[source]

This method is used to upload a PKCS#12 file. Upload the file to the p12FileUpload form data field .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • p12_password (basestring) – p12Password query parameter. P12 Passsword .

  • pk_password (basestring) – pkPassword query parameter. Private Key Passsword .

  • list_of_users (basestring, list, set, tuple) – listOfUsers query parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 2.2.2.3).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • mac_address (basestring) – macAddress query parameter. MAC Address of the client .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

client_proximity(username, number_days=None, time_resolution=None, headers=None, **request_parameters)[source]

This intent API will provide client proximity information for a specific wireless user. Proximity is defined as presence on the same floor at the same time as the specified wireless user. The Proximity workflow requires the subscription to the following event (via the Event Notification workflow) prior to making this API call: NETWORK-CLIENTS-3-506 Client Proximity Report. .

Parameters:
  • username (basestring) – username query parameter. Wireless client username for which proximity information is required .

  • number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days. .

  • time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 2.2.2.3).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs .

Parameters:
  • commands (list) – Command Runner’s commands (list of strings).

  • description (string) – Command Runner’s description.

  • deviceUuids (list) – Command Runner’s deviceUuids (list of strings).

  • name (string) – Command Runner’s name.

  • timeout (integer) – Command Runner’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

compliance

class Compliance[source]

Cisco DNA Center Compliance API (version: 2.2.2.3).

Wraps the DNA Center Compliance API and exposes the API as native Python methods that return native Python objects.

get_compliance_status_(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_compliance(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Run compliance check for device(s). .

Parameters:
  • categories (list) – Compliance’s categories (list of strings).

  • deviceUuids (list) – Compliance’s deviceUuids (list of strings).

  • triggerFull (boolean) – Compliance’s triggerFull.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status_count(compliance_status=None, headers=None, **request_parameters)[source]

Return Compliance Status Count .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_detail(compliance_status=None, compliance_type=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return Compliance Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’ .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_detail_count(compliance_status=None, compliance_type=None, headers=None, **request_parameters)[source]

Return Compliance Count Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_compliance_status(device_uuid, headers=None, **request_parameters)[source]

Return compliance status of a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

compliance_details_of_device(device_uuid, category=None, compliance_type=None, diff_list=None, key=None, value=None, headers=None, **request_parameters)[source]

Return compliance detailed report for a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • category (basestring) – category query parameter. complianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ .

  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’ .

  • diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ] .

  • key (basestring) – key query parameter. extended attribute key .

  • value (basestring) – value query parameter. extended attribute value .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_archive

class ConfigurationArchive[source]

Cisco DNA Center Configuration Archive API (version: 2.2.2.3).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Export Device configurations to an encrypted zip file. .

Parameters:
  • deviceId (list) – Configuration Archive’s Device Id (list of strings).

  • password (string) – Configuration Archive’s Password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 2.2.2.3).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

clone_given_template(name, project_id, template_id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to clone template .

Parameters:
  • name (basestring) – name path parameter. Template name to clone template(Name should be different than existing template name within same project) .

  • template_id (basestring) – templateId path parameter. UUID of the template to clone it .

  • project_id (basestring) – projectId path parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to create a new project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (list) – Configuration Templates’s List of templates within the project (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to update an existing project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (list) – Configuration Templates’s List of templates within the project (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, sort_order=None, headers=None, **request_parameters)[source]

List the projects .

Parameters:
  • name (basestring) – name query parameter. Name of project to be searched .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

imports_the_projects_provided(do_version=None, headers=None, payload=None, **request_parameters)[source]

Imports the Projects provided in the DTO .

Parameters:
  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (basestring) – A string object to send in the body of the Request.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_projects(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the projects for given projectNames. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

imports_the_templates_provided(project_name, do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Imports the templates provided in the DTO by project Name .

Parameters:
  • project_name (basestring) – projectName path parameter. Project name to create template under the project .

  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_project_details(project_id, headers=None, **request_parameters)[source]

Get the details of the given project by its id. .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to get project details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_the_project(project_id, headers=None, **request_parameters)[source]

Deletes the project by its id .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a template by project id. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • project_id (basestring) – projectId path parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, project_names=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)[source]

List the templates available .

Parameters:
  • project_id (basestring) – projectId query parameter. Filter template(s) based on project UUID .

  • software_type (basestring) – softwareType query parameter. Filter template(s) based software type .

  • software_version (basestring) – softwareVersion query parameter. Filter template(s) based softwareVersion .

  • product_family (basestring) – productFamily query parameter. Filter template(s) based on device family .

  • product_series (basestring) – productSeries query parameter. Filter template(s) based on device series .

  • product_type (basestring) – productType query parameter. Filter template(s) based on device type .

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

  • tags (basestring, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

  • project_names (basestring, list, set, tuple) – projectNames query parameter. Filter template(s) based on project names .

  • un_committed (bool) – unCommitted query parameter. Filter template(s) based on template commited or not .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a template. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of objects).

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

API to retrieve the status of template deployment. .

Parameters:
  • deployment_id (basestring) – deploymentId path parameter. UUID of deployment to retrieve template deployment status .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_templates(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the templates for given templateIds. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(deviceId=None, params=None, resourceParams=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to preview a template. .

Parameters:
  • deviceId (string) – Configuration Templates’s UUID of device to get template preview .

  • params (object) – Configuration Templates’s Params to render preview .

  • resourceParams (list) – Configuration Templates’s Resource params to render preview (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to get template preview .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to version the current contents of the template. .

Parameters:
  • comments (string) – Configuration Templates’s Template version comments .

  • templateId (string) – Configuration Templates’s UUID of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Get all the versions of template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) to get list of versioned templates .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_the_template(template_id, headers=None, **request_parameters)[source]

Deletes the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) of template to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Details of the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. TemplateId(UUID) to get details of the template .

  • latest_version (bool) – latestVersion query parameter. latestVersion flag to get the latest versioned template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template_v2(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

V2 API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of objects).

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 2.2.2.3).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database. .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (int) – limit query parameter. Limits number of results .

  • offset (int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • mac_address (basestring) – macAddress query parameter. Device Mac Address .

  • hostname (basestring) – hostname query parameter. Device Hostname .

  • site_name (basestring) – siteName query parameter. Device Site Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow .

Parameters:
  • configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

  • fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

  • populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination .

Parameters:
  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Device Serial Number .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state .

Parameters:
  • deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • name (basestring) – name path parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms. .

Parameters:
  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration .

Parameters:
  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow .

Parameters:
  • deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • aaaCredentials (object) – Device Onboarding (PnP)’s aaaCredentials.

  • acceptEula (boolean) – Device Onboarding (PnP)’s acceptEula.

  • defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

  • savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Device Onboarding (PnP)’s taskTimeOuts.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information .

Parameters:
  • domain (basestring) – domain query parameter. Smart Account Domain .

  • name (basestring) – name query parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (int) – limit query parameter. Limits number of results .

  • offset (int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • type (basestring, list, set, tuple) – type query parameter. Workflow Type .

  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count .

Parameters:
  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_replacement

class DeviceReplacement[source]

Cisco DNA Center Device Replacement API (version: 2.2.2.3).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)[source]

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family. .

Parameters:
  • faulty_device_name (basestring) – faultyDeviceName query parameter. Faulty Device Name .

  • faulty_device_platform (basestring) – faultyDevicePlatform query parameter. Faulty Device Platform .

  • replacement_device_platform (basestring) – replacementDevicePlatform query parameter. Replacement Device Platform .

  • faulty_device_serial_number (basestring) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number .

  • replacement_device_serial_number (basestring) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number .

  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED] .

  • family (basestring, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP] .

  • sort_by (basestring) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. .

  • sort_order (basestring) – sortOrder query parameter. Order on displayName[ASC,DESC] .

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

UnMarks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Marks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)[source]

Get replacement devices count .

Parameters:
  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images .

Parameters:
  • faultyDeviceSerialNumber (string) – Device Replacement’s faultyDeviceSerialNumber.

  • replacementDeviceSerialNumber (string) – Device Replacement’s replacementDeviceSerialNumber.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 2.2.2.3).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the device data is required .

  • search_by (basestring) – searchBy query parameter. MAC Address or Device Name value or UUID of the network device .

  • identifier (basestring) – identifier query parameter. One of keywords : macAddress or uuid or nwDeviceName .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. .

Parameters:
  • device_role (basestring) – deviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP) .

  • site_id (basestring) – siteId query parameter. Assurance site UUID value .

  • health (basestring) – health query parameter. The device overall health (One of POOR, FAIR, GOOD) .

  • start_time (int) – startTime query parameter. UTC epoch time in milliseconds .

  • end_time (int) – endTime query parameter. UTC epoch time in miliseconds .

  • limit (int) – limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) .

  • offset (int) – offset query parameter. The offset of the first device in the returned data .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=None, offset=None, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces for specified device management IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. IP address of the interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • name (basestring) – name query parameter. Interface name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID .

Parameters:
  • id (basestring) – id path parameter. Interface ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, device_support_level=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..* If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. .

  • device_support_level (basestring) – deviceSupportLevel query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_all_network_devices(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes. .

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router .

Parameters:
  • id (string) – Devices’s id.

  • role (string) – Devices’s role.

  • roleSource (string) – Devices’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file .

Parameters:
  • deviceUuids (list) – Devices’s deviceUuids (list of strings).

  • id (string) – Devices’s id.

  • operationEnum (string) – Devices’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – Devices’s parameters (list of strings).

  • password (string) – Devices’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices .

Parameters:
  • device_id (basestring) – deviceId query parameter. Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list. .

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id .

Parameters:
  • id (basestring) – id path parameter. Functional Capability UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Find all devices with link mismatch (speed / vlan) .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (basestring) – offset query parameter. Row Number. Default value is 1 .

  • limit (basestring) – limit query parameter. Default value is 500 .

  • category (basestring) – category query parameter. Links mismatch category. Value can be speed-duplex or vlan. .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter. Order. Value can be asc or desc. Default value is asc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_with_snmpv3_des(site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns devices added to DNAC with snmp v3 DES, where siteId is mandatory & accepts offset, limit, sortby, order which are optional. .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (basestring) – offset query parameter. Row Number. Default value is 1 .

  • limit (basestring) – limit query parameter. Default value is 500 .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. Device IP address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number .

Parameters:
  • serial_number (basestring) – serialNumber path parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device .

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Serial number of the device .

  • macaddress (basestring) – macaddress query parameter. Mac addres of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_chassis_details_for_device(device_id, headers=None, **request_parameters)[source]

Returns chassis details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_stack_details_for_device(device_id, headers=None, **request_parameters)[source]

Retrieves complete stack details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_power_supply_fan_details_for_the_given_device(device_uuid, type, headers=None, **request_parameters)[source]

Return PowerSupply/ Fan details for the Given device .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • type (basestring) – type query parameter. Type value should be PowerSupply or Fan .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_interface_details(device_uuid, interface_name_list=None, headers=None, **request_parameters)[source]

Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names which is optional and returns information for that particular interfaces where(operStatus = operationalStatus) .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • interface_name_list (basestring) – interfaceNameList query parameter. comma seperated interface names .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_linecard_details(device_uuid, headers=None, **request_parameters)[source]

Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details_(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_supervisor_card_detail(device_uuid, headers=None, **request_parameters)[source]

Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, is_force_delete=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • is_force_delete (bool) – isForceDelete query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs .

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – interfaceType query parameter. Vlan assocaited with sub-interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID .

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_details(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details for the Rogue and aWIPS threats .

Parameters:
  • endTime (integer) – Devices’s End Time.

  • isNewThreat (boolean) – Devices’s Is New Threat.

  • limit (integer) – Devices’s Limit.

  • offset (integer) – Devices’s Offset.

  • siteId (list) – Devices’s Site Id (list of strings).

  • startTime (integer) – Devices’s Start Time.

  • threatLevel (list) – Devices’s Threat Level (list of strings).

  • threatType (list) – Devices’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_detail_count(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details count for the Rogue and aWIPS threats .

Parameters:
  • endTime (integer) – Devices’s End Time.

  • isNewThreat (boolean) – Devices’s Is New Threat.

  • limit (integer) – Devices’s Limit.

  • offset (integer) – Devices’s Offset.

  • siteId (list) – Devices’s Site Id (list of strings).

  • startTime (integer) – Devices’s Start Time.

  • threatLevel (list) – Devices’s Threat Level (list of strings).

  • threatType (list) – Devices’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_summary(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The Threat Summary for the Rogues and aWIPS .

Parameters:
  • endTime (integer) – Devices’s End Time.

  • siteId (list) – Devices’s Site Id (list of strings).

  • startTime (integer) – Devices’s Start Time.

  • threatLevel (list) – Devices’s Threat Level (list of strings).

  • threatType (list) – Devices’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 2.2.2.3).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery .

Parameters:
  • attributeInfo (object) – Discovery’s attributeInfo.

  • cdpLevel (integer) – Discovery’s cdpLevel.

  • deviceIds (string) – Discovery’s deviceIds.

  • discoveryCondition (string) – Discovery’s discoveryCondition.

  • discoveryStatus (string) – Discovery’s discoveryStatus.

  • discoveryType (string) – Discovery’s discoveryType.

  • enablePasswordList (string) – Discovery’s enablePasswordList.

  • globalCredentialIdList (list) – Discovery’s globalCredentialIdList (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • id (string) – Discovery’s id.

  • ipAddressList (string) – Discovery’s ipAddressList.

  • ipFilterList (string) – Discovery’s ipFilterList.

  • isAutoCdp (boolean) – Discovery’s isAutoCdp.

  • lldpLevel (integer) – Discovery’s lldpLevel.

  • name (string) – Discovery’s name.

  • netconfPort (string) – Discovery’s netconfPort.

  • numDevices (integer) – Discovery’s numDevices.

  • parentDiscoveryId (string) – Discovery’s parentDiscoveryId.

  • passwordList (string) – Discovery’s passwordList.

  • preferredMgmtIPMethod (string) – Discovery’s preferredMgmtIPMethod.

  • protocolOrder (string) – Discovery’s protocolOrder.

  • retryCount (integer) – Discovery’s retryCount.

  • snmpAuthPassphrase (string) – Discovery’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Discovery’s snmpAuthProtocol.

  • snmpMode (string) – Discovery’s snmpMode.

  • snmpPrivPassphrase (string) – Discovery’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Discovery’s snmpPrivProtocol.

  • snmpRoCommunity (string) – Discovery’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – Discovery’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – Discovery’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – Discovery’s snmpRwCommunityDesc.

  • snmpUserName (string) – Discovery’s snmpUserName.

  • timeOut (integer) – Discovery’s timeOut.

  • updateMgmtIp (boolean) – Discovery’s updateMgmtIp.

  • userNameList (string) – Discovery’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters .

Parameters:
  • cdpLevel (integer) – Discovery’s CDP level to which neighbor devices to be discovered .

  • discoveryType (string) – Discovery’s Type of Discovery. ‘SINGLE’, ‘RANGE’, ‘MULTI RANGE’, ‘CDP’, ‘LLDP’ .

  • enablePasswordList (list) – Discovery’s Enable Password of the devices to be discovered (list of strings).

  • globalCredentialIdList (list) – Discovery’s Global Credential Ids to be used for discovery (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • ipAddressList (string) – Discovery’s IP Address of devices to be discovered. Ex: ‘172.30.0.1’ for SINGLE, CDP and LLDP; ‘72.30.0.1-172.30.0.4’ for RANGE; ‘72.30.0.1-172.30.0.4,172.31.0.1-172.31.0.4’ for MULTI RANGE .

  • ipFilterList (list) – Discovery’s IP Addresses of the devices to be filtered out during discovery (list of strings).

  • lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

  • name (string) – Discovery’s Name of the discovery .

  • netconfPort (string) – Discovery’s Netconf Port. It will need valid SSH credentials to work .

  • passwordList (list) – Discovery’s Password of the devices to be discovered (list of strings).

  • preferredMgmtIPMethod (string) – Discovery’s Preferred Management IP Method.’None’ or ‘UseLoopBack’. Default is ‘None’ .

  • protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

  • retry (integer) – Discovery’s Number of times to try establishing connection to device .

  • snmpAuthPassphrase (string) – Discovery’s Auth Pass phrase for SNMP .

  • snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

  • snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

  • snmpPrivPassphrase (string) – Discovery’s Pass phrase for SNMP privacy .

  • snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘DES’ or ‘AES128’ .

  • snmpROCommunity (string) – Discovery’s Snmp RO community of the devices to be discovered .

  • snmpROCommunityDesc (string) – Discovery’s Description for Snmp RO community .

  • snmpRWCommunity (string) – Discovery’s Snmp RW community of the devices to be discovered .

  • snmpRWCommunityDesc (string) – Discovery’s Description for Snmp RW community .

  • snmpUserName (string) – Discovery’s SNMP username of the device .

  • snmpVersion (string) – Discovery’s Version of SNMP. v2 or v3 .

  • timeout (integer) – Discovery’s Time to wait for device response in seconds .

  • userNameList (list) – Discovery’s Username of the devices to be discovered (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_delete (int) – recordsToDelete path parameter. Number of records to delete .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type .

Parameters:
  • credential_sub_type (basestring) – credentialSubType query parameter. Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF .

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • enablePassword (string) – Discovery’s enablePassword.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • netconfPort (string) – Discovery’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • readCommunity (string) – Discovery’s readCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • writeCommunity (string) – Discovery’s writeCommunity.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential .

Parameters:
  • authPassword (string) – Discovery’s authPassword.

  • authType (string) – Discovery’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • privacyPassword (string) – Discovery’s privacyPassword.

  • privacyType (string) – Discovery’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – Discovery’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID .

Parameters:
  • global_credential_id (basestring) – globalCredentialId path parameter. ID of global-credential .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s) .

Parameters:
  • siteUuids (list) – Discovery’s siteUuids (list of strings).

  • global_credential_id (basestring) – globalCredentialId path parameter. Global credential Uuid .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id .

Parameters:
  • id (basestring) – id path parameter. Global Credential ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 2.2.2.3).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

get_auditlog_parent_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Parent Audit Log Event instances from the Event-Hub .

Parameters:
  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_summary(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_parent_only=None, is_system_events=None, name=None, parent_instance_id=None, severity=None, site_id=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Summary from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • is_parent_only (bool) – isParentOnly query parameter. Parameter to filter parent only audit-logs. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, parent_instance_id=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Event instances from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter .

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=None, offset=None, order=None, severity=None, sort_by=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • offset (int) – offset query parameter. Start Offset .

  • limit (int) – limit query parameter. # of records .

  • sort_by (basestring) – sortBy query parameter. Sort By column .

  • order (basestring) – order query parameter. Ascending/Descending order [asc/desc] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions .

Parameters:
  • subscriptions (basestring) – subscriptions query parameter. List of EventSubscriptionId’s for removal .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [EMAIL] .

  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [REST] .

  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [SYSLOG] .

  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Email Subscription Endpoint for list of registered events. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Email Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of email Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Rest/Webhook Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Syslog Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • offset (int) – offset query parameter. The number of Registries to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Registries to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_eventartifacts(event_ids=None, limit=None, offset=None, order=None, search=None, sort_by=None, tags=None, headers=None, **request_parameters)[source]

Gets the list of artifacts based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of eventIds .

  • tags (basestring) – tags query parameter. Tags defined .

  • offset (int) – offset query parameter. Record start offset .

  • limit (int) – limit query parameter. # of records to return in result set .

  • sort_by (basestring) – sortBy query parameter. Sort by field .

  • order (basestring) – order query parameter. sorting order (asc/desc) .

  • search (basestring) – search query parameter. findd matches in name, description, eventId, type, category .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

eventartifact_count(headers=None, **request_parameters)[source]

Get the count of registered event artifacts with provided eventIds or tags as mandatory .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 2.2.2.3).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace .

Parameters:
  • name_space (basestring) – nameSpace path parameter. A listing of fileId’s .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId .

Parameters:
  • file_id (basestring) – fileId path parameter. File Identification number .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

health_and_performance

class HealthAndPerformance[source]

Cisco DNA Center Health and Performance API (version: 2.2.2.3).

Wraps the DNA Center Health and Performance API and exposes the API as native Python methods that return native Python objects.

system_health(domain=None, limit=None, offset=None, subdomain=None, summary=None, headers=None, **request_parameters)[source]

This API retrieves the latest system events .

Parameters:
  • summary (bool) – summary query parameter. Fetch the latest high severity event .

  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_health_count(domain=None, subdomain=None, headers=None, **request_parameters)[source]

This API gives the count of the latest system events .

Parameters:
  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_performance(end_time=None, function=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API gives the aggregated performance indicators. The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Valid values: cpu,memory,network .

  • function (basestring) – function query parameter. Valid values: sum,average,max .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_performance_historical(end_time=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API retrieves the historical performance indicators . The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Fetch historical data for this kpi. Valid values: cpu,memory,network .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

itsm

class Itsm[source]

Cisco DNA Center ITSM API (version: 2.2.2.3).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_cmdb_sync_status(date=None, status=None, headers=None, **request_parameters)[source]

This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter “status”,”date”.The supported values for status field are “Success”,”Failed”,”Unknown” and date field should be in “YYYY-MM- DD” format. By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response. .

Parameters:
  • status (basestring) – status query parameter. Supported values are “Success”,”Failed” and “Unknown”. Providing other values will result in all the available sync job status. .

  • date (basestring) – date query parameter. Provide date in “YYYY-MM-DD” format .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)[source]

Used to retrieve the list of integration events that failed to create tickets in ITSM .

Parameters:
  • instance_id (basestring) – instanceId query parameter. Instance Id of the failed event as in the Runtime Dashboard .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 2.2.2.3).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues(ai_driven=None, device_id=None, end_time=None, issue_status=None, mac_address=None, priority=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device’s MAC address. .

Parameters:
  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of query time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of query time window .

  • site_id (basestring) – siteId query parameter. Assurance UUID value of the site in the issue content .

  • device_id (basestring) – deviceId query parameter. Assurance UUID value of the device in the issue content .

  • mac_address (basestring) – macAddress query parameter. Client’s device MAC address of the issue (format xx:xx:xx:xx:xx:xx) .

  • priority (basestring) – priority query parameter. The issue’s priority value (One of P1, P2, P3, or P4)(Use only when macAddress and deviceId are not provided) .

  • ai_driven (basestring) – aiDriven query parameter. The issue’s AI driven value (Yes or No)(Use only when macAddress and deviceId are not provided) .

  • issue_status (basestring) – issueStatus query parameter. The issue’s status value (One of ACTIVE, IGNORED, RESOLVED) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

licenses

class Licenses[source]

Cisco DNA Center Licenses API (version: 2.2.2.3).

Wraps the DNA Center Licenses API and exposes the API as native Python methods that return native Python objects.

device_count_details(device_type=None, dna_level=None, registration_status=None, smart_account_id=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Get total number of managed device(s). .

Parameters:
  • device_type (basestring) – device_type query parameter. Type of device .

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA license level .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Name of virtual account .

  • smart_account_id (basestring) – smart_account_id query parameter. Id of smart account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_license_summary(limit, order, page_number, device_type=None, device_uuid=None, dna_level=None, registration_status=None, smart_account_id=None, sort_by=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Show license summary of device(s). .

Parameters:
  • page_number (int) – page_number query parameter. Page number of response .

  • order (basestring) – order query parameter. Sorting order .

  • sort_by (basestring) – sort_by query parameter. Sort result by field .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA license level .

  • device_type (basestring) – device_type query parameter. Type of device .

  • limit (int) – limit query parameter.

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Name of virtual account .

  • smart_account_id (int) – smart_account_id query parameter. Id of smart account .

  • device_uuid (basestring) – device_uuid query parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_license_details(device_uuid, headers=None, **request_parameters)[source]

Get detailed license information of a device. .

Parameters:
  • device_uuid (basestring) – device_uuid path parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_deregistration(device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deregister device(s) from CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_registration(virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Register device(s) in CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

change_virtual_account(smart_account_id, virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Transfer device(s) from one virtual account to another within same smart account. .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of target virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

virtual_account_details(smart_account_id, headers=None, **request_parameters)[source]

Get virtual account details of a smart account. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

smart_account_details(headers=None, **request_parameters)[source]

Get detail of all smart accounts. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

license_term_details(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get license term details. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license term detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

license_usage_details(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get count of purchased and in use DNA and Network licenses. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license usage detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 2.2.2.3).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential To Site .

Parameters:
  • cliId (string) – Network Settings’s Cli Id.

  • httpRead (string) – Network Settings’s Http Read.

  • httpWrite (string) – Network Settings’s Http Write.

  • snmpV2ReadId (string) – Network Settings’s Snmp V2 Read Id.

  • snmpV2WriteId (string) – Network Settings’s Snmp V2 Write Id.

  • snmpV3Id (string) – Network Settings’s Snmp V3 Id.

  • site_id (basestring) – siteId path parameter. site id to assign credential. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve the credential details associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential. .

Parameters:
  • id (basestring) – id path parameter. global credential id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool. .

Parameters:
  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool. .

Parameters:
  • id (basestring) – id path parameter. global pool id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to get the network settings associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP and DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to which site details to associate with the network settings. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network for DHCP and DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to update the network settings which is associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_reserve_ip_subpool(limit=None, offset=None, site_id=None, headers=None, **request_parameters)[source]

API to get the ip subpool info. .

Parameters:
  • site_id (basestring) – siteId query parameter. site id to get the reserve ip associated with the site .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

release_reserve_ip_subpool(id, headers=None, **request_parameters)[source]

API to delete the reserved ip subpool .

Parameters:
  • id (basestring) – id path parameter. Id of reserve ip subpool to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reserve_ip_subpool(site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv4GlobalPool=None, ipv4Prefix=None, ipv4PrefixLength=None, ipv4Subnet=None, ipv4TotalHost=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to reserve an ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv4GateWay (string) – Network Settings’s Gateway ip address details, example: 175.175.0.1 .

  • ipv4GlobalPool (string) – Network Settings’s IP v4 Global pool address with cidr, example: 175.175.0.0/16 .

  • ipv4Prefix (boolean) – Network Settings’s IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable .

  • ipv4PrefixLength (integer) – Network Settings’s The ipv4 prefix length is required when ipv4prefix value is true. .

  • ipv4Subnet (string) – Network Settings’s IPv4 Subnet address, example: 175.175.0.0 .

  • ipv4TotalHost (integer) – Network Settings’s IPv4 total host is required when ipv4prefix value is false. .

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • type (string) – Network Settings’s Type of the reserve ip sub pool . Available values are ‘Generic’, ‘LAN’, ‘WAN’, ‘management’ and ‘service’.

  • site_id (basestring) – siteId path parameter. Site id to reserve the ip sub pool. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_reserve_ip_subpool(id, site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IP v6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s IPv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • site_id (basestring) – siteId path parameter. Site id of site to update sub pool. .

  • id (basestring) – id query parameter. Id of subpool to be associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS). .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create service provider profile(QOS). .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update SP profile .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS). .

Parameters:
  • sp_profile_name (basestring) – sp-profile-name path parameter. sp profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 2.2.2.3).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters. .

Parameters:
  • periodic_refresh (bool) – periodicRefresh query parameter. Is analysis periodically refreshed? .

  • source_ip (basestring) – sourceIP query parameter. Source IP address .

  • dest_ip (basestring) – destIP query parameter. Destination IP adress .

  • source_port (basestring) – sourcePort query parameter. Source port .

  • dest_port (basestring) – destPort query parameter. Destination port .

  • gt_create_time (basestring) – gtCreateTime query parameter. Analyses requested after this time .

  • lt_create_time (basestring) – ltCreateTime query parameter. Analyses requested before this time .

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – taskId query parameter. Task ID .

  • last_update_time (basestring) – lastUpdateTime query parameter. Last update time .

  • limit (basestring) – limit query parameter. Number of resources returned .

  • offset (basestring) – offset query parameter. Start index of resources returned (1-based) .

  • order (basestring) – order query parameter. Order by this field .

  • sort_by (basestring) – sortBy query parameter. Sort by this field .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress. .

Parameters:
  • controlPath (boolean) – Path Trace’s controlPath.

  • destIP (string) – Path Trace’s destIP.

  • destPort (string) – Path Trace’s destPort.

  • inclusions (list) – Path Trace’s inclusions (list of strings).

  • periodicRefresh (boolean) – Path Trace’s periodicRefresh.

  • protocol (string) – Path Trace’s protocol.

  • sourceIP (string) – Path Trace’s sourceIP.

  • sourcePort (string) – Path Trace’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

platform_configuration

class PlatformConfiguration[source]

Cisco DNA Center Platform Configuration API (version: 2.2.2.3).

Wraps the DNA Center Platform Configuration API and exposes the API as native Python methods that return native Python objects.

release_summary(headers=None, **request_parameters)[source]

Provides information such as API version, mandatory core packages for installation or upgrade, optional packages, Cisco DNA Center name and version, supported direct updates, and tenant ID. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nodes_configuration_summary(headers=None, **request_parameters)[source]

Provides details about the current Cisco DNA Center node configuration, such as API version, node name, NTP server, intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default gateway, and interface information. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reports

class Reports[source]

Cisco DNA Center Reports API (version: 2.2.2.3).

Wraps the DNA Center Reports API and exposes the API as native Python methods that return native Python objects.

create_or_schedule_a_report(deliveries=None, name=None, schedule=None, tags=None, view=None, viewGroupId=None, viewGroupVersion=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Schedule a report configuration. Use “Get view details for a given view group & view” API to get the metadata required to configure a report. .

Parameters:
  • deliveries (list) – Reports’s Array of available delivery channels (list of objects).

  • name (string) – Reports’s report name .

  • schedule (object) – Reports’s schedule.

  • tags (list) – Reports’s array of tags for report (list of strings).

  • view (object) – Reports’s view.

  • viewGroupId (string) – Reports’s viewGroupId of the viewgroup for the report .

  • viewGroupVersion (string) – Reports’s version of viewgroup for the report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_scheduled_reports(view_group_id=None, view_id=None, headers=None, **request_parameters)[source]

Get list of scheduled report configurations. .

Parameters:
  • view_group_id (basestring) – viewGroupId query parameter. viewGroupId of viewgroup for report .

  • view_id (basestring) – viewId query parameter. viewId of view for report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Get scheduled report configuration by reportId .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Delete a scheduled report configuration. Deletes the report executions also. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_execution_details_for_a_given_report(report_id, headers=None, **request_parameters)[source]

Get details of all executions for a given report .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_report_content(execution_id, report_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • execution_id (basestring) – executionId path parameter. executionId of report execution .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

get_all_view_groups(headers=None, **request_parameters)[source]

Gives a list of summary of all view groups. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_views_for_a_given_view_group(view_group_id, headers=None, **request_parameters)[source]

Gives a list of summary of all views in a viewgroup. Use “Get all view groups” API to get the viewGroupIds (required as a query param for this API) for available viewgroups. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_view_details_for_a_given_view_group_and_view(view_group_id, view_id, headers=None, **request_parameters)[source]

Gives complete information of the view that is required to configure a report. Use “Get views for a given view group” API to get the viewIds (required as a query param for this API) for available views. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup .

  • view_id (basestring) – viewId path parameter. view id of view .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sda

class Sda[source]

Cisco DNA Center SDA API (version: 2.2.2.3).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

get_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication profile in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Add default authentication profile in SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_ipaddress, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_ipaddress, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_control_plane_device(device_ipaddress, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_control_plane_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_info(device_ipaddress, headers=None, **request_parameters)[source]

Get device info from SDA Fabric .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_role_in_sda_fabric(device_management_ip_address, headers=None, **request_parameters)[source]

Get device role in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Device Management IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric. .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_ipaddress, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sda_fabric(fabric_name, headers=None, **request_parameters)[source]

Delete SDA Fabric .

Parameters:
  • fabric_name (basestring) – fabricName query parameter. Fabric Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_info(fabric_name, headers=None, **request_parameters)[source]

Get SDA Fabric Info .

Parameters:
  • fabric_name (basestring) – fabricName query parameter. Fabric Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_fabric(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_site(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_count(headers=None, **request_parameters)[source]

Get SDA Fabric Count .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_access_point(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric .

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_access_point(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric .

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric. .

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_ip, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric. .

Parameters:
  • device_ip (basestring) – device-ip query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_multicast_in_sda_fabric(fabricSiteNameHierarchy=None, multicastMethod=None, multicastVnInfo=None, muticastType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add multicast in SDA fabric .

Parameters:
  • fabricSiteNameHierarchy (string) – SDA’s fabricSiteNameHierarchy .

  • multicastMethod (string) – SDA’s multicast methods . Available values are ‘native_multicast’ and ‘’.

  • multicastVnInfo (object) – SDA’s multicastVnInfo.

  • muticastType (string) – SDA’s muticast type . Available values are ‘ssm’, ‘asm_with_external_rp’ and ‘’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_multicast_details_from_sda_fabric(fabric_site_name_hierarchy, headers=None, **request_parameters)[source]

Get multicast details from SDA fabric .

Parameters:
  • fabric_site_name_hierarchy (basestring) – fabricSiteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_multicast_from_sda_fabric(fabric_site_name_hierarchy, headers=None, **request_parameters)[source]

Delete multicast from SDA fabric .

Parameters:
  • fabric_site_name_hierarchy (basestring) – fabricSiteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Valid IP address of the device currently provisioned in a fabric site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision Wired Device .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Device Management Ip Address.

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get Provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_vn(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network .

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network .

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, virtualNetworkName=None, virtualNetworkType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network with scalable groups at global level .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s isGuestVirtualNetwork.

  • scalableGroupNames (list) – SDA’s Scalable Group Names (list of strings).

  • virtualNetworkName (string) – SDA’s Virtual Network Name.

  • virtualNetworkType (string) – SDA’s Virtual Network Type.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, virtualNetworkName=None, virtualNetworkType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update virtual network with scalable groups .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s Is Guest Virtual Network.

  • scalableGroupNames (list) – SDA’s Scalable Group Names (list of strings).

  • virtualNetworkName (string) – SDA’s Virtual Network Name.

  • virtualNetworkType (string) – SDA’s Virtual Network Type.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

security_advisories

class SecurityAdvisories[source]

Cisco DNA Center Security Advisories API (version: 2.2.2.3).

Wraps the DNA Center Security Advisories API and exposes the API as native Python methods that return native Python objects.

get_advisories_list(headers=None, **request_parameters)[source]

Retrieves list of advisories on the network .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_summary(headers=None, **request_parameters)[source]

Retrieves summary of advisories on the network. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_per_advisory(advisory_id, headers=None, **request_parameters)[source]

Retrieves list of devices for an advisory .

Parameters:
  • advisory_id (basestring) – advisoryId path parameter. Advisory ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisory_ids_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisory IDs for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisories for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors

class Sensors[source]

Cisco DNA Center Sensors API (version: 2.2.2.3).

Wraps the DNA Center Sensors API and exposes the API as native Python methods that return native Python objects.

edit_sensor_test_template(locationInfoList=None, schedule=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to deploy, schedule, or edit and existing SENSOR test template .

Parameters:
  • locationInfoList (list) – Sensors’s locationInfoList (list of objects).

  • schedule (object) – Sensors’s schedule.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sensor_test_template(apCoverage=None, connection=None, modelVersion=None, name=None, ssids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID .

Parameters:
  • apCoverage (list) – Sensors’s apCoverage (list of objects).

  • connection (string) – Sensors’s Connection.

  • modelVersion (integer) – Sensors’s Model Version.

  • name (string) – Sensors’s Name.

  • ssids (list) – Sensors’s ssids (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sensor_test(template_name=None, headers=None, **request_parameters)[source]

Intent API to delete an existing SENSOR test template .

Parameters:
  • template_name (basestring) – templateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors(site_id=None, headers=None, **request_parameters)[source]

Intent API to get a list of SENSOR devices .

Parameters:
  • site_id (basestring) – siteId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_now_sensor_test(templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to run a deployed SENSOR test .

Parameters:
  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

duplicate_sensor_test_template(newTemplateName=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to duplicate an existing SENSOR test template .

Parameters:
  • newTemplateName (string) – Sensors’s New Template Name.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 2.2.2.3).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor . .

Parameters:
  • provisioning (list) – Site Design’s provisioning (list of objects).

  • siteProfile (list) – Site Design’s siteProfile (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address. .

Parameters:
  • device_ip (basestring) – deviceIp query parameter. Device to which the provisioning detail has to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information. .

Parameters:
  • device_ip (string) – Site Design’s Device Ip.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network profile for different NFV topologies .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • profileName (string) – Site Design’s Name of the profile to create NFV profile .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a NFV Network profile .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • id (basestring) – id path parameter. Id of the NFV profile to be updated .

  • name (basestring) – name query parameter. Name of the profile to be updated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

API to get NFV network profile. .

Parameters:
  • id (basestring) – id path parameter. ID of network profile to retrieve. .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. Number of profile to be retrieved .

  • name (basestring) – name query parameter. Name of network profile to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_nfv_profile(id, name=None, headers=None, **request_parameters)[source]

API to delete nfv network profile. .

Parameters:
  • id (basestring) – id path parameter. Id of nfv network profile to delete. .

  • name (basestring) – name query parameter. Nameof nfv network profile to delete. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_floormap(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Service to create a floor map with callback .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_floormaps(headers=None, **request_parameters)[source]

List all floor maps .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_floormap(floor_id, headers=None, **request_parameters)[source]

Service to delete an (empty) floor map with callback .

Parameters:
  • floor_id (basestring) – floorId path parameter. Group ID of floor to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_floormap(floor_id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Service to create a floor map with callback .

Parameters:
  • floor_id (basestring) – floorId path parameter. Group ID of the floor to be modified .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_floormap(floor_id, headers=None, **request_parameters)[source]

List specified floor map(s) .

Parameters:
  • floor_id (basestring) – floorId path parameter. Group Id of the specified floormap .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 2.2.2.3).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

get_membership(site_id, device_family=None, limit=None, offset=None, serial_number=None, headers=None, **request_parameters)[source]

Getting the site children details and device details. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to retrieve device associated with the site. .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. Number of sites to be retrieved .

  • device_family (basestring) – deviceFamily query parameter. Device family name .

  • serial_number (basestring) – serialNumber query parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy. .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type of site to create (eg: area, building, floor) . Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site using siteNameHierarchy/siteId/type ,return all sites if these parameters are not given as input. .

Parameters:
  • name (basestring) – name query parameter. siteNameHierarchy (ex: global/groupName) .

  • site_id (basestring) – siteId query parameter. Site id to which site details to retrieve. .

  • type (basestring) – type query parameter. type (ex: area, building, floor) .

  • offset (basestring) – offset query parameter. offset/starting row. The default value is 1 .

  • limit (basestring) – limit query parameter. Number of sites to be retrieved. The default value is 500 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve site count. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – siteId path parameter. Site id to which site details to be updated. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to which site details to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site .

Parameters:
  • device (list) – Sites’s device (list of objects).

  • site_id (basestring) – siteId path parameter. Site id to which site the device to assign .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 2.2.2.3).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash .

Parameters:
  • schedule_validate (bool) – scheduleValidate query parameter. scheduleValidate, validates data before schedule (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order=None, version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%” .

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus query parameter. imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED .

  • version (basestring) – version query parameter. software Image Version .

  • image_series (basestring) – imageSeries query parameter. image Series .

  • image_name (basestring) – imageName query parameter. image Name .

  • is_tagged_golden (bool) – isTaggedGolden query parameter. is Tagged Golden .

  • is_cco_recommended (bool) – isCCORecommended query parameter. is recommended from cisco.com .

  • is_cco_latest (bool) – isCCOLatest query parameter. is latest from cisco.com .

  • created_time (int) – createdTime query parameter. time in milliseconds (epoch format) .

  • image_size_greater_than (int) – imageSizeGreaterThan query parameter. size in bytes .

  • image_size_lesser_than (int) – imageSizeLesserThan query parameter. size in bytes .

  • sort_by (basestring) – sortBy query parameter. sort results by this field .

  • sort_order (basestring) – sortOrder query parameter. sort order ‘asc’ or ‘des’. Default is asc .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2. Upload the file to the file form data field .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – isThirdParty query parameter. Third party Image check .

  • third_party_vendor (basestring) – thirdPartyVendor query parameter. Third Party Vendor .

  • third_party_image_family (basestring) – thirdPartyImageFamily query parameter. Third Party image family .

  • third_party_application_type (basestring) – thirdPartyApplicationType query parameter. Third Party Application Type .

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2 .

Parameters:
  • schedule_at (basestring) – scheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – scheduleDesc query parameter. Custom Description (Optional) .

  • schedule_origin (basestring) – scheduleOrigin query parameter. Originator of this call (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 2.2.2.3).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria .

Parameters:
  • name (basestring) – name query parameter. Tag name is mandatory when filter operation is used. .

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • field (basestring) – field query parameter. Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’ .

  • sort_by (basestring) – sortBy query parameter. Only supported attribute is name. SortyBy is mandatory when order is used. .

  • order (basestring) – order query parameter. Available values are asc and des .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count .

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API .

Parameters:
  • memberToTags (list) – Tag’s memberToTags (list of objects).

  • memberType (string) – Tag’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level=None, limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API .

  • offset (basestring) – offset query parameter. Used for pagination. It indicates the starting row number out of available member records .

  • limit (basestring) – limit query parameter. Used to Number of maximum members to return in the result .

  • member_association_type (basestring) – memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag .

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level=None, member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_id (basestring) – memberId path parameter. TagMember id to be removed from tag .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 2.2.2.3).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – sortBy query parameter. Sort results by this field .

  • order (basestring) – order query parameter. Sort order asc or dsc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid .

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – offset path parameter. Index, minimum value is 0 .

  • limit (int) – limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 2.2.2.3).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Network health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID .

Parameters:
  • vlan_id (basestring) – vlanID path parameter. Vlan Name for e.g Vlan1, Vlan23 etc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol .

Parameters:
  • topology_type (basestring) – topologyType path parameter. Type of topology(OSPF,ISIS,etc) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType .

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 2.2.2.3).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 2.2.2.3).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

sensor_test_results(end_time=None, site_id=None, start_time=None, test_failure_by=None, headers=None, **request_parameters)[source]

Intent API to get SENSOR test result summary .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID .

  • start_time (int) – startTime query parameter. The epoch time in milliseconds .

  • end_time (int) – endTime query parameter. The epoch time in milliseconds .

  • test_failure_by (basestring) – testFailureBy query parameter. Obtain failure statistics group by “area”, “building”, or “floor” .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites .

Parameters:
  • enableFabric (boolean) – Wireless’s Enable SSID for Fabric .

  • flexConnect (object) – Wireless’s flexConnect.

  • managedAPLocations (list) – Wireless’s Managed AP Locations (Enter entire Site(s) hierarchy) (list of strings).

  • ssidDetails (object) – Wireless’s ssidDetails.

  • ssidType (string) – Wireless’s SSID Type . Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center .

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName query parameter. Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout .

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcast SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service .

  • enableFastLane (boolean) – Wireless’s Enable Fast Lane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List .

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client . Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s Enter SSID Name .

  • passphrase (string) – Wireless’s Pass Phrase (Only applicable for SSID with PERSONAL security level) .

  • radioPolicy (string) – Wireless’s Radio Policy . Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout .

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcast SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service .

  • enableFastLane (boolean) – Wireless’s Enable Fast Lane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List .

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client . Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s Enter SSID Name .

  • passphrase (string) – Wireless’s Pass Phrase (Only applicable for SSID with PERSONAL security level) .

  • radioPolicy (string) – Wireless’s Radio Policy . Available values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’ and ‘2.4GHz only’.

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName path parameter. Enter the SSID name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided. .

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter. Wireless Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Access Point Provision and ReProvision .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_dynamic_interface(interfaceName=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create or update an dynamic interface .

Parameters:
  • interfaceName (string) – Wireless’s dynamic-interface name .

  • vlanId (number) – Wireless’s Vlan Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_dynamic_interface(interface_name=None, headers=None, **request_parameters)[source]

Get one or all dynamic interface(s) .

Parameters:
  • interface_name (basestring) – interface-name query parameter. dynamic-interface name, if not specified all the existing dynamic interfaces will be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_dynamic_interface(interface_name, headers=None, **request_parameters)[source]

Delete a dynamic interface .

Parameters:
  • interface_name (basestring) – interfaceName path parameter. valid interface-name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile. .

Parameters:
  • profile_name (basestring) – profileName query parameter. Wireless Network Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

psk_override(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update/override pass phrase of enterprise SSID .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles .

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile .

Parameters:
  • channelWidth (string) – Wireless’s rf-profile channel width .

  • defaultRfProfile (boolean) – Wireless’s isDefault rf-profile .

  • enableBrownField (boolean) – Wireless’s true if enable brown field for rf-profile else false .

  • enableCustom (boolean) – Wireless’s true if enable custom rf-profile else false .

  • enableRadioTypeA (boolean) – Wireless’s tru if Enable Radio Type A else false .

  • enableRadioTypeB (boolean) – Wireless’s true if Enable Radio Type B else false .

  • name (string) – Wireless’s custom RF profile name .

  • radioTypeAProperties (object) – Wireless’s radioTypeAProperties.

  • radioTypeBProperties (object) – Wireless’s radioTypeBProperties.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s) .

Parameters:
  • rf_profile_name (basestring) – rfProfileName path parameter. RF profile name to be deleted(required) non_custom RF profile cannot be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v2.2.3.3

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 2.2.3.3).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_application_policy(policy_scope=None, headers=None, **request_parameters)[source]

Get all existing application policies .

Parameters:
  • policy_scope (basestring) – policyScope query parameter. policy scope name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_policy_default(headers=None, **request_parameters)[source]

Get default application policy .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

application_policy_intent(createList=None, deleteList=None, updateList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Update/Delete application policy .

Parameters:
  • createList (list) – Application Policy’s createList (list of objects).

  • deleteList (list) – Application Policy’s Delete list of Group Based Policy ids (list of strings).

  • updateList (list) – Application Policy’s updateList (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_policy_queuing_profile(name=None, headers=None, **request_parameters)[source]

Get all or by name, existing application policy queuing profiles .

Parameters:
  • name (basestring) – name query parameter. queuing profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update existing custom application queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_policy_queuing_profile_count(headers=None, **request_parameters)[source]

Get the number of all existing application policy queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_policy_queuing_profile(id, headers=None, **request_parameters)[source]

Delete existing custom application policy queuing profile by id .

Parameters:
  • id (basestring) – id path parameter. Id of custom queuing profile to delete .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id .

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id .

Parameters:
  • id (basestring) – id query parameter. Application’s Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name .

Parameters:
  • offset (int) – offset query parameter. The offset of the first application to be returned .

  • limit (int) – limit query parameter. The maximum number of applications to be returned .

  • name (basestring) – name query parameter. Application’s name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_qos_device_interface_info(network_device_id=None, headers=None, **request_parameters)[source]

Get all or by network device id, existing qos device interface infos .

Parameters:
  • network_device_id (basestring) – networkDeviceId query parameter. network device id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update existing qos device interface infos associate with network device id .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create qos device interface infos associate with network device id to allow the user to mark specific interfaces as WAN, to associate WAN interfaces with specific SP Profile and to be able to define a shaper on WAN interfaces .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_qos_device_interface_info_count(headers=None, **request_parameters)[source]

Get the number of all existing qos device interface infos group by network device id .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_qos_device_interface_info(id, headers=None, **request_parameters)[source]

Delete all qos device interface infos associate with network device id .

Parameters:
  • id (basestring) – id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

applications

class Applications[source]

Cisco DNA Center Applications API (version: 2.2.3.3).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications(application_health=None, application_name=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of applications for a specific site, a device, or a client device’s MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints. .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac) .

  • device_id (basestring) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac) .

  • mac_address (basestring) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId) .

  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window .

  • application_health (basestring) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) .

  • offset (int) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) .

  • limit (int) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) .

  • application_name (basestring) – applicationName query parameter. The name of the application to get information on .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

authentication_management

class AuthenticationManagement[source]

Cisco DNA Center Authentication Management API (version: 2.2.3.3).

Wraps the DNA Center Authentication Management API and exposes the API as native Python methods that return native Python objects.

import_certificate(multipart_fields, multipart_monitor_callback, list_of_users=None, pk_password=None, headers=None, **request_parameters)[source]

This method is used to upload a certificate. Upload the files to the certFileUpload and pkFileUpload form data fields .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • pk_password (basestring) – pkPassword query parameter. Private Key Passsword .

  • list_of_users (basestring, list, set, tuple) – listOfUsers query parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_certificate_p12(multipart_fields, multipart_monitor_callback, list_of_users=None, p12_password=None, pk_password=None, headers=None, **request_parameters)[source]

This method is used to upload a PKCS#12 file. Upload the file to the p12FileUpload form data field .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • p12_password (basestring) – p12Password query parameter. P12 Passsword .

  • pk_password (basestring) – pkPassword query parameter. Private Key Passsword .

  • list_of_users (basestring, list, set, tuple) – listOfUsers query parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 2.2.3.3).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • mac_address (basestring) – macAddress query parameter. MAC Address of the client .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

client_proximity(username, number_days=None, time_resolution=None, headers=None, **request_parameters)[source]

This intent API will provide client proximity information for a specific wireless user. Proximity is defined as presence on the same floor at the same time as the specified wireless user. The Proximity workflow requires the subscription to the following event (via the Event Notification workflow) prior to making this API call: NETWORK-CLIENTS-3-506 Client Proximity Report. .

Parameters:
  • username (basestring) – username query parameter. Wireless client username for which proximity information is required .

  • number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days. .

  • time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 2.2.3.3).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs .

Parameters:
  • commands (list) – Command Runner’s commands (list of strings).

  • description (string) – Command Runner’s description.

  • deviceUuids (list) – Command Runner’s deviceUuids (list of strings).

  • name (string) – Command Runner’s name.

  • timeout (integer) – Command Runner’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

compliance

class Compliance[source]

Cisco DNA Center Compliance API (version: 2.2.3.3).

Wraps the DNA Center Compliance API and exposes the API as native Python methods that return native Python objects.

get_compliance_status_(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_compliance(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Run compliance check for device(s). .

Parameters:
  • categories (list) – Compliance’s categories (list of strings).

  • deviceUuids (list) – Compliance’s deviceUuids (list of strings).

  • triggerFull (boolean) – Compliance’s triggerFull.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status_count(compliance_status=None, headers=None, **request_parameters)[source]

Return Compliance Status Count .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_detail(compliance_status=None, compliance_type=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return Compliance Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’ .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_detail_count(compliance_status=None, compliance_type=None, headers=None, **request_parameters)[source]

Return Compliance Count Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_compliance_status(device_uuid, headers=None, **request_parameters)[source]

Return compliance status of a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

compliance_details_of_device(device_uuid, category=None, compliance_type=None, diff_list=None, key=None, value=None, headers=None, **request_parameters)[source]

Return compliance detailed report for a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • category (basestring) – category query parameter. complianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ .

  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’ .

  • diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ] .

  • key (basestring) – key query parameter. extended attribute key .

  • value (basestring) – value query parameter. extended attribute value .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_archive

class ConfigurationArchive[source]

Cisco DNA Center Configuration Archive API (version: 2.2.3.3).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Export Device configurations to an encrypted zip file. .

Parameters:
  • deviceId (list) – Configuration Archive’s Device Id (list of strings).

  • password (string) – Configuration Archive’s Password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 2.2.3.3).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

clone_given_template(name, project_id, template_id, headers=None, **request_parameters)[source]

API to clone template .

Parameters:
  • name (basestring) – name path parameter. Template name to clone template(Name should be different than existing template name within same project) .

  • template_id (basestring) – templateId path parameter. UUID of the template to clone it .

  • project_id (basestring) – projectId path parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to create a new project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (list) – Configuration Templates’s List of templates within the project (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to update an existing project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (list) – Configuration Templates’s List of templates within the project (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, sort_order=None, headers=None, **request_parameters)[source]

List the projects .

Parameters:
  • name (basestring) – name query parameter. Name of project to be searched .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

imports_the_projects_provided(do_version=None, headers=None, payload=None, **request_parameters)[source]

Imports the Projects provided in the DTO .

Parameters:
  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (basestring) – A string object to send in the body of the Request.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_projects(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the projects for given projectNames. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

imports_the_templates_provided(project_name, do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Imports the templates provided in the DTO by project Name .

Parameters:
  • project_name (basestring) – projectName path parameter. Project name to create template under the project .

  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_project_details(project_id, headers=None, **request_parameters)[source]

Get the details of the given project by its id. .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to get project details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_the_project(project_id, headers=None, **request_parameters)[source]

Deletes the project by its id .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a template by project id. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • project_id (basestring) – projectId path parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, project_names=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)[source]

List the templates available .

Parameters:
  • project_id (basestring) – projectId query parameter. Filter template(s) based on project UUID .

  • software_type (basestring) – softwareType query parameter. Filter template(s) based software type .

  • software_version (basestring) – softwareVersion query parameter. Filter template(s) based softwareVersion .

  • product_family (basestring) – productFamily query parameter. Filter template(s) based on device family .

  • product_series (basestring) – productSeries query parameter. Filter template(s) based on device series .

  • product_type (basestring) – productType query parameter. Filter template(s) based on device type .

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

  • tags (basestring, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

  • project_names (basestring, list, set, tuple) – projectNames query parameter. Filter template(s) based on project names .

  • un_committed (bool) – unCommitted query parameter. Filter template(s) based on template commited or not .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a template. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of objects).

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

API to retrieve the status of template deployment. .

Parameters:
  • deployment_id (basestring) – deploymentId path parameter. UUID of deployment to retrieve template deployment status .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_templates(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the templates for given templateIds. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(deviceId=None, params=None, resourceParams=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to preview a template. .

Parameters:
  • deviceId (string) – Configuration Templates’s UUID of device to get template preview .

  • params (object) – Configuration Templates’s Params to render preview .

  • resourceParams (list) – Configuration Templates’s Resource params to render preview (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to get template preview .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to version the current contents of the template. .

Parameters:
  • comments (string) – Configuration Templates’s Template version comments .

  • templateId (string) – Configuration Templates’s UUID of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Get all the versions of template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) to get list of versioned templates .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_the_template(template_id, headers=None, **request_parameters)[source]

Deletes the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) of template to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Details of the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. TemplateId(UUID) to get details of the template .

  • latest_version (bool) – latestVersion query parameter. latestVersion flag to get the latest versioned template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects_details(id=None, limit=None, name=None, offset=None, sort_order=None, headers=None, **request_parameters)[source]

Get project(s) details .

Parameters:
  • id (basestring) – id query parameter. Id of project to be searched .

  • name (basestring) – name query parameter. Name of project to be searched .

  • offset (int) – offset query parameter. Index of first result .

  • limit (int) – limit query parameter. Limits number of results .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_templates_details(all_template_attributes=None, filter_conflicting_templates=None, id=None, include_version_details=None, limit=None, name=None, offset=None, product_family=None, product_series=None, product_type=None, project_id=None, project_name=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)[source]

Get template(s) details .

Parameters:
  • id (basestring) – id query parameter. Id of template to be searched .

  • name (basestring) – name query parameter. Name of template to be searched .

  • project_id (basestring) – projectId query parameter. Filter template(s) based on project id .

  • project_name (basestring) – projectName query parameter. Filter template(s) based on project name .

  • software_type (basestring) – softwareType query parameter. Filter template(s) based software type .

  • software_version (basestring) – softwareVersion query parameter. Filter template(s) based softwareVersion .

  • product_family (basestring) – productFamily query parameter. Filter template(s) based on device family .

  • product_series (basestring) – productSeries query parameter. Filter template(s) based on device series .

  • product_type (basestring) – productType query parameter. Filter template(s) based on device type .

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

  • tags (basestring, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

  • un_committed (bool) – unCommitted query parameter. Return uncommitted template .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

  • all_template_attributes (bool) – allTemplateAttributes query parameter. Return all template attributes .

  • include_version_details (bool) – includeVersionDetails query parameter. Include template version details .

  • offset (int) – offset query parameter. Index of first result .

  • limit (int) – limit query parameter. Limits number of results .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template_v2(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

V2 API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of objects).

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 2.2.3.3).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database. .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (int) – limit query parameter. Limits number of results .

  • offset (int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • mac_address (basestring) – macAddress query parameter. Device Mac Address .

  • hostname (basestring) – hostname query parameter. Device Hostname .

  • site_name (basestring) – siteName query parameter. Device Site Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow .

Parameters:
  • configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

  • fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

  • populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination .

Parameters:
  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Device Serial Number .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state .

Parameters:
  • deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • name (basestring) – name path parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(configInfo=None, deviceId=None, gateway=None, hostname=None, imageId=None, imageInfo=None, ipInterfaceName=None, rfProfile=None, siteId=None, staticIP=None, subnetMask=None, type=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms. .

Parameters:
  • configInfo (object) – Device Onboarding (PnP)’s configInfo.

  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • gateway (string) – Device Onboarding (PnP)’s gateway.

  • hostname (string) – Device Onboarding (PnP)’s hostname.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • imageInfo (object) – Device Onboarding (PnP)’s imageInfo.

  • ipInterfaceName (string) – Device Onboarding (PnP)’s ipInterfaceName.

  • rfProfile (string) – Device Onboarding (PnP)’s rfProfile.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • staticIP (string) – Device Onboarding (PnP)’s staticIP.

  • subnetMask (string) – Device Onboarding (PnP)’s subnetMask.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • vlanId (string) – Device Onboarding (PnP)’s vlanId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration .

Parameters:
  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow .

Parameters:
  • deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • aaaCredentials (object) – Device Onboarding (PnP)’s aaaCredentials.

  • acceptEula (boolean) – Device Onboarding (PnP)’s acceptEula.

  • defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

  • savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Device Onboarding (PnP)’s taskTimeOuts.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information .

Parameters:
  • domain (basestring) – domain query parameter. Smart Account Domain .

  • name (basestring) – name query parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (int) – limit query parameter. Limits number of results .

  • offset (int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • type (basestring, list, set, tuple) – type query parameter. Workflow Type .

  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count .

Parameters:
  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_replacement

class DeviceReplacement[source]

Cisco DNA Center Device Replacement API (version: 2.2.3.3).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)[source]

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family. .

Parameters:
  • faulty_device_name (basestring) – faultyDeviceName query parameter. Faulty Device Name .

  • faulty_device_platform (basestring) – faultyDevicePlatform query parameter. Faulty Device Platform .

  • replacement_device_platform (basestring) – replacementDevicePlatform query parameter. Replacement Device Platform .

  • faulty_device_serial_number (basestring) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number .

  • replacement_device_serial_number (basestring) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number .

  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED] .

  • family (basestring, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP] .

  • sort_by (basestring) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. .

  • sort_order (basestring) – sortOrder query parameter. Order on displayName[ASC,DESC] .

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

UnMarks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Marks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)[source]

Get replacement devices count .

Parameters:
  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images .

Parameters:
  • faultyDeviceSerialNumber (string) – Device Replacement’s faultyDeviceSerialNumber.

  • replacementDeviceSerialNumber (string) – Device Replacement’s replacementDeviceSerialNumber.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 2.2.3.3).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the device data is required .

  • search_by (basestring) – searchBy query parameter. MAC Address or Device Name value or UUID of the network device .

  • identifier (basestring) – identifier query parameter. One of keywords : macAddress or uuid or nwDeviceName .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. .

Parameters:
  • device_role (basestring) – deviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP) .

  • site_id (basestring) – siteId query parameter. Assurance site UUID value .

  • health (basestring) – health query parameter. The device overall health (One of POOR, FAIR, GOOD) .

  • start_time (int) – startTime query parameter. UTC epoch time in milliseconds .

  • end_time (int) – endTime query parameter. UTC epoch time in miliseconds .

  • limit (int) – limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) .

  • offset (int) – offset query parameter. The offset of the first device in the returned data .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=None, offset=None, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces for specified device management IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. IP address of the interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • name (basestring) – name query parameter. Interface name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID .

Parameters:
  • id (basestring) – id path parameter. Interface ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, device_support_level=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..* If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. .

  • device_support_level (basestring) – deviceSupportLevel query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, id=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • id (string) – Devices’s id.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_values_that_match_fully_or_partially_an_attribute(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Returns the list of values of the first given required parameter. You can use the .* in any value to conduct a wildcard search. For example, to get all the devices with the management IP address starting with 10.10. , issue the following request: GET /dna/inten/api/v1/network- device/autocomplete?managementIpAddress=10.10..* It will return the device management IP addresses that match fully or partially the provided attribute. {[10.10.1.1, 10.10.20.2, …]}. .

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router .

Parameters:
  • id (string) – Devices’s id.

  • role (string) – Devices’s role.

  • roleSource (string) – Devices’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file .

Parameters:
  • deviceUuids (list) – Devices’s deviceUuids (list of strings).

  • id (string) – Devices’s id.

  • operationEnum (string) – Devices’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – Devices’s parameters (list of strings).

  • password (string) – Devices’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices .

Parameters:
  • device_id (basestring) – deviceId query parameter. Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list. .

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id .

Parameters:
  • id (basestring) – id path parameter. Functional Capability UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Find all devices with link mismatch (speed / vlan) .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (basestring) – offset query parameter. Row Number. Default value is 1 .

  • limit (basestring) – limit query parameter. Default value is 500 .

  • category (basestring) – category query parameter. Links mismatch category. Value can be speed-duplex or vlan. .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter. Order. Value can be asc or desc. Default value is asc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_with_snmpv3_des(site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns devices added to DNAC with snmp v3 DES, where siteId is mandatory & accepts offset, limit, sortby, order which are optional. .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (basestring) – offset query parameter. Row Number. Default value is 1 .

  • limit (basestring) – limit query parameter. Default value is 500 .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. Device IP address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring) – limit query parameter.

  • offset (basestring) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number .

Parameters:
  • serial_number (basestring) – serialNumber path parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device .

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Serial number of the device .

  • macaddress (basestring) – macaddress query parameter. Mac addres of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_chassis_details_for_device(device_id, headers=None, **request_parameters)[source]

Returns chassis details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_stack_details_for_device(device_id, headers=None, **request_parameters)[source]

Retrieves complete stack details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_power_supply_fan_details_for_the_given_device(device_uuid, type, headers=None, **request_parameters)[source]

Return PowerSupply/ Fan details for the Given device .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • type (basestring) – type query parameter. Type value should be PowerSupply or Fan .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_interface_details(device_uuid, interface_name_list=None, headers=None, **request_parameters)[source]

Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names which is optional and returns information for that particular interfaces where(operStatus = operationalStatus) .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • interface_name_list (basestring) – interfaceNameList query parameter. comma seperated interface names .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_linecard_details(device_uuid, headers=None, **request_parameters)[source]

Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details_(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_supervisor_card_detail(device_uuid, headers=None, **request_parameters)[source]

Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, clean_config=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • clean_config (bool) – cleanConfig query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs .

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – interfaceType query parameter. Vlan assocaited with sub-interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID .

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_details(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details for the Rogue and aWIPS threats .

Parameters:
  • endTime (integer) – Devices’s End Time.

  • isNewThreat (boolean) – Devices’s Is New Threat.

  • limit (integer) – Devices’s Limit.

  • offset (integer) – Devices’s Offset.

  • siteId (list) – Devices’s Site Id (list of strings).

  • startTime (integer) – Devices’s Start Time.

  • threatLevel (list) – Devices’s Threat Level (list of strings).

  • threatType (list) – Devices’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_detail_count(endTime=None, isNewThreat=None, limit=None, offset=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The details count for the Rogue and aWIPS threats .

Parameters:
  • endTime (integer) – Devices’s End Time.

  • isNewThreat (boolean) – Devices’s Is New Threat.

  • limit (integer) – Devices’s Limit.

  • offset (integer) – Devices’s Offset.

  • siteId (list) – Devices’s Site Id (list of strings).

  • startTime (integer) – Devices’s Start Time.

  • threatLevel (list) – Devices’s Threat Level (list of strings).

  • threatType (list) – Devices’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

threat_summary(endTime=None, siteId=None, startTime=None, threatLevel=None, threatType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

The Threat Summary for the Rogues and aWIPS .

Parameters:
  • endTime (integer) – Devices’s End Time.

  • siteId (list) – Devices’s Site Id (list of strings).

  • startTime (integer) – Devices’s Start Time.

  • threatLevel (list) – Devices’s Threat Level (list of strings).

  • threatType (list) – Devices’s Threat Type (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

disaster_recovery

class DisasterRecovery[source]

Cisco DNA Center Disaster Recovery API (version: 2.2.3.3).

Wraps the DNA Center Disaster Recovery API and exposes the API as native Python methods that return native Python objects.

disaster_recovery_operational_status(headers=None, **request_parameters)[source]

Returns the status of Disaster Recovery operation performed on the system. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

disaster_recovery_status(headers=None, **request_parameters)[source]

Detailed and Summarized status of DR components (Active, Standby and Witness system’s health). .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 2.2.3.3).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery .

Parameters:
  • attributeInfo (object) – Discovery’s attributeInfo.

  • cdpLevel (integer) – Discovery’s cdpLevel.

  • deviceIds (string) – Discovery’s deviceIds.

  • discoveryCondition (string) – Discovery’s discoveryCondition.

  • discoveryStatus (string) – Discovery’s discoveryStatus.

  • discoveryType (string) – Discovery’s discoveryType.

  • enablePasswordList (string) – Discovery’s enablePasswordList.

  • globalCredentialIdList (list) – Discovery’s globalCredentialIdList (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • id (string) – Discovery’s id.

  • ipAddressList (string) – Discovery’s ipAddressList.

  • ipFilterList (string) – Discovery’s ipFilterList.

  • isAutoCdp (boolean) – Discovery’s isAutoCdp.

  • lldpLevel (integer) – Discovery’s lldpLevel.

  • name (string) – Discovery’s name.

  • netconfPort (string) – Discovery’s netconfPort.

  • numDevices (integer) – Discovery’s numDevices.

  • parentDiscoveryId (string) – Discovery’s parentDiscoveryId.

  • passwordList (string) – Discovery’s passwordList.

  • preferredMgmtIPMethod (string) – Discovery’s preferredMgmtIPMethod.

  • protocolOrder (string) – Discovery’s protocolOrder.

  • retryCount (integer) – Discovery’s retryCount.

  • snmpAuthPassphrase (string) – Discovery’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Discovery’s snmpAuthProtocol.

  • snmpMode (string) – Discovery’s snmpMode.

  • snmpPrivPassphrase (string) – Discovery’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Discovery’s snmpPrivProtocol.

  • snmpRoCommunity (string) – Discovery’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – Discovery’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – Discovery’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – Discovery’s snmpRwCommunityDesc.

  • snmpUserName (string) – Discovery’s snmpUserName.

  • timeOut (integer) – Discovery’s timeOut.

  • updateMgmtIp (boolean) – Discovery’s updateMgmtIp.

  • userNameList (string) – Discovery’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters .

Parameters:
  • cdpLevel (integer) – Discovery’s CDP level to which neighbor devices to be discovered .

  • discoveryType (string) – Discovery’s Type of Discovery. ‘SINGLE’, ‘RANGE’, ‘MULTI RANGE’, ‘CDP’, ‘LLDP’ .

  • enablePasswordList (list) – Discovery’s Enable Password of the devices to be discovered (list of strings).

  • globalCredentialIdList (list) – Discovery’s Global Credential Ids to be used for discovery (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • ipAddressList (string) – Discovery’s IP Address of devices to be discovered. Ex: ‘172.30.0.1’ for SINGLE, CDP and LLDP; ‘72.30.0.1-172.30.0.4’ for RANGE; ‘72.30.0.1-172.30.0.4,172.31.0.1-172.31.0.4’ for MULTI RANGE .

  • ipFilterList (list) – Discovery’s IP Addresses of the devices to be filtered out during discovery (list of strings).

  • lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

  • name (string) – Discovery’s Name of the discovery .

  • netconfPort (string) – Discovery’s Netconf Port. It will need valid SSH credentials to work .

  • passwordList (list) – Discovery’s Password of the devices to be discovered (list of strings).

  • preferredMgmtIPMethod (string) – Discovery’s Preferred Management IP Method.’None’ or ‘UseLoopBack’. Default is ‘None’ .

  • protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

  • retry (integer) – Discovery’s Number of times to try establishing connection to device .

  • snmpAuthPassphrase (string) – Discovery’s Auth Pass phrase for SNMP .

  • snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

  • snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

  • snmpPrivPassphrase (string) – Discovery’s Pass phrase for SNMP privacy .

  • snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘DES’ or ‘AES128’ .

  • snmpROCommunity (string) – Discovery’s Snmp RO community of the devices to be discovered .

  • snmpROCommunityDesc (string) – Discovery’s Description for Snmp RO community .

  • snmpRWCommunity (string) – Discovery’s Snmp RW community of the devices to be discovered .

  • snmpRWCommunityDesc (string) – Discovery’s Description for Snmp RW community .

  • snmpUserName (string) – Discovery’s SNMP username of the device .

  • snmpVersion (string) – Discovery’s Version of SNMP. v2 or v3 .

  • timeout (integer) – Discovery’s Time to wait for device response in seconds .

  • userNameList (list) – Discovery’s Username of the devices to be discovered (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_delete (int) – recordsToDelete path parameter. Number of records to delete .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type .

Parameters:
  • credential_sub_type (basestring) – credentialSubType query parameter. Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF .

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • enablePassword (string) – Discovery’s enablePassword.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • netconfPort (string) – Discovery’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community .

Parameters:
  • comments (string) – Discovery’s Comments to identify the credential .

  • credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s Name/Description of the credential .

  • instanceUuid (string) – Discovery’s instanceUuid.

  • readCommunity (string) – Discovery’s SNMP read community. NO!$DATA!$ for no value change .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community .

Parameters:
  • comments (string) – Discovery’s Comments to identify the credential .

  • credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s Name/Description of the credential .

  • instanceUuid (string) – Discovery’s instanceUuid.

  • writeCommunity (string) – Discovery’s SNMP write community. NO!$DATA!$ for no value change .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential .

Parameters:
  • authPassword (string) – Discovery’s authPassword.

  • authType (string) – Discovery’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • privacyPassword (string) – Discovery’s privacyPassword.

  • privacyType (string) – Discovery’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – Discovery’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID .

Parameters:
  • global_credential_id (basestring) – globalCredentialId path parameter. ID of global-credential .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s) .

Parameters:
  • siteUuids (list) – Discovery’s siteUuids (list of strings).

  • global_credential_id (basestring) – globalCredentialId path parameter. Global credential Uuid .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id .

Parameters:
  • id (basestring) – id path parameter. Global Credential ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 2.2.3.3).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

get_auditlog_parent_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Parent Audit Log Event instances from the Event-Hub .

Parameters:
  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_summary(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_parent_only=None, is_system_events=None, name=None, parent_instance_id=None, severity=None, site_id=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Summary from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • is_parent_only (bool) – isParentOnly query parameter. Parameter to filter parent only audit-logs. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, parent_instance_id=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Event instances from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter .

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=None, offset=None, order=None, severity=None, sort_by=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • offset (int) – offset query parameter. Start Offset .

  • limit (int) – limit query parameter. # of records .

  • sort_by (basestring) – sortBy query parameter. Sort By column .

  • order (basestring) – order query parameter. Ascending/Descending order [asc/desc] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions .

Parameters:
  • subscriptions (basestring) – subscriptions query parameter. List of EventSubscriptionId’s for removal .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [EMAIL] .

  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [REST] .

  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_subscription_details(connector_type, instance_id=None, name=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • connector_type (basestring) – connectorType query parameter. Connector Type [SYSLOG] .

  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Email Subscription Endpoint for list of registered events. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Email Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of email Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Rest/Webhook Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Syslog Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • offset (int) – offset query parameter. The number of Registries to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Registries to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_eventartifacts(event_ids=None, limit=None, offset=None, order=None, search=None, sort_by=None, tags=None, headers=None, **request_parameters)[source]

Gets the list of artifacts based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of eventIds .

  • tags (basestring) – tags query parameter. Tags defined .

  • offset (int) – offset query parameter. Record start offset .

  • limit (int) – limit query parameter. # of records to return in result set .

  • sort_by (basestring) – sortBy query parameter. Sort by field .

  • order (basestring) – order query parameter. sorting order (asc/desc) .

  • search (basestring) – search query parameter. findd matches in name, description, eventId, type, category .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

eventartifact_count(headers=None, **request_parameters)[source]

Get the count of registered event artifacts with provided eventIds or tags as mandatory .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

fabric_wireless

class FabricWireless[source]

Cisco DNA Center Fabric Wireless API (version: 2.2.3.3).

Wraps the DNA Center Fabric Wireless API and exposes the API as native Python methods that return native Python objects.

add_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SSID to IP Pool Mapping. .

Parameters:
  • scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

  • vlanName (string) – Fabric Wireless’s VLAN Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SSID to IP Pool Mapping. .

Parameters:
  • scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

  • vlanName (string) – Fabric Wireless’s VLAN Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ssid_to_ip_pool_mapping(site_name_hierarchy, vlan_name, headers=None, **request_parameters)[source]

Get SSID to IP Pool Mapping .

Parameters:
  • vlan_name (basestring) – vlanName query parameter. VLAN Name .

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Heirarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_w_l_c_from_fabric_domain(device_ipaddress, headers=None, **request_parameters)[source]

Remove WLC from Fabric Domain .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device Management IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_w_l_c_to_fabric_domain(deviceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add WLC to Fabric Domain .

Parameters:
  • deviceName (string) – Fabric Wireless’s EWLC Device Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 2.2.3.3).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace .

Parameters:
  • name_space (basestring) – nameSpace path parameter. A listing of fileId’s .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId .

Parameters:
  • file_id (basestring) – fileId path parameter. File Identification number .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

health_and_performance

class HealthAndPerformance[source]

Cisco DNA Center Health and Performance API (version: 2.2.3.3).

Wraps the DNA Center Health and Performance API and exposes the API as native Python methods that return native Python objects.

system_health(domain=None, limit=None, offset=None, subdomain=None, summary=None, headers=None, **request_parameters)[source]

This API retrieves the latest system events .

Parameters:
  • summary (bool) – summary query parameter. Fetch the latest high severity event .

  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_health_count(domain=None, subdomain=None, headers=None, **request_parameters)[source]

This API gives the count of the latest system events .

Parameters:
  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_performance(end_time=None, function=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API gives the aggregated performance indicators. The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Valid values: cpu,memory,network .

  • function (basestring) – function query parameter. Valid values: sum,average,max .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_performance_historical(end_time=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API retrieves the historical performance indicators . The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Fetch historical data for this kpi. Valid values: cpu,memory,network .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

itsm

class Itsm[source]

Cisco DNA Center ITSM API (version: 2.2.3.3).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_cmdb_sync_status(date=None, status=None, headers=None, **request_parameters)[source]

This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter “status”,”date”.The supported values for status field are “Success”,”Failed”,”Unknown” and date field should be in “YYYY-MM- DD” format. By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response. .

Parameters:
  • status (basestring) – status query parameter. Supported values are “Success”,”Failed” and “Unknown”. Providing other values will result in all the available sync job status. .

  • date (basestring) – date query parameter. Provide date in “YYYY-MM-DD” format .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)[source]

Used to retrieve the list of integration events that failed to create tickets in ITSM .

Parameters:
  • instance_id (basestring) – instanceId query parameter. Instance Id of the failed event as in the Runtime Dashboard .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 2.2.3.3).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues(ai_driven=None, device_id=None, end_time=None, issue_status=None, mac_address=None, priority=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device’s MAC address. .

Parameters:
  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of query time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of query time window .

  • site_id (basestring) – siteId query parameter. Assurance UUID value of the site in the issue content .

  • device_id (basestring) – deviceId query parameter. Assurance UUID value of the device in the issue content .

  • mac_address (basestring) – macAddress query parameter. Client’s device MAC address of the issue (format xx:xx:xx:xx:xx:xx) .

  • priority (basestring) – priority query parameter. The issue’s priority value (One of P1, P2, P3, or P4)(Use only when macAddress and deviceId are not provided) .

  • ai_driven (basestring) – aiDriven query parameter. The issue’s AI driven value (Yes or No)(Use only when macAddress and deviceId are not provided) .

  • issue_status (basestring) – issueStatus query parameter. The issue’s status value (One of ACTIVE, IGNORED, RESOLVED) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

licenses

class Licenses[source]

Cisco DNA Center Licenses API (version: 2.2.3.3).

Wraps the DNA Center Licenses API and exposes the API as native Python methods that return native Python objects.

device_count_details(device_type=None, dna_level=None, registration_status=None, smart_account_id=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Get total number of managed device(s). .

Parameters:
  • device_type (basestring) – device_type query parameter. Type of device .

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA license level .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Name of virtual account .

  • smart_account_id (basestring) – smart_account_id query parameter. Id of smart account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_license_summary(limit, order, page_number, device_type=None, device_uuid=None, dna_level=None, registration_status=None, smart_account_id=None, sort_by=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Show license summary of device(s). .

Parameters:
  • page_number (int) – page_number query parameter. Page number of response .

  • order (basestring) – order query parameter. Sorting order .

  • sort_by (basestring) – sort_by query parameter. Sort result by field .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA license level .

  • device_type (basestring) – device_type query parameter. Type of device .

  • limit (int) – limit query parameter.

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Name of virtual account .

  • smart_account_id (int) – smart_account_id query parameter. Id of smart account .

  • device_uuid (basestring) – device_uuid query parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_license_details(device_uuid, headers=None, **request_parameters)[source]

Get detailed license information of a device. .

Parameters:
  • device_uuid (basestring) – device_uuid path parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_deregistration(device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deregister device(s) from CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_registration(virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Register device(s) in CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

change_virtual_account(smart_account_id, virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Transfer device(s) from one virtual account to another within same smart account. .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of target virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

virtual_account_details(smart_account_id, headers=None, **request_parameters)[source]

Get virtual account details of a smart account. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

smart_account_details(headers=None, **request_parameters)[source]

Get detail of all smart accounts. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

license_term_details(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get license term details. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license term detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

license_usage_details(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get count of purchased and in use Cisco DNA and Network licenses. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license usage detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 2.2.3.3).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential To Site .

Parameters:
  • cliId (string) – Network Settings’s Cli Id.

  • httpRead (string) – Network Settings’s Http Read.

  • httpWrite (string) – Network Settings’s Http Write.

  • snmpV2ReadId (string) – Network Settings’s Snmp V2 Read Id.

  • snmpV2WriteId (string) – Network Settings’s Snmp V2 Write Id.

  • snmpV3Id (string) – Network Settings’s Snmp V3 Id.

  • site_id (basestring) – siteId path parameter. site id to assign credential. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve the credential details associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential. .

Parameters:
  • id (basestring) – id path parameter. global credential id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool. .

Parameters:
  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool. .

Parameters:
  • id (basestring) – id path parameter. global pool id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to get the network settings associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP and DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to which site details to associate with the network settings. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network for DHCP and DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to update the network settings which is associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_reserve_ip_subpool(limit=None, offset=None, site_id=None, headers=None, **request_parameters)[source]

API to get the ip subpool info. .

Parameters:
  • site_id (basestring) – siteId query parameter. site id to get the reserve ip associated with the site .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

release_reserve_ip_subpool(id, headers=None, **request_parameters)[source]

API to delete the reserved ip subpool .

Parameters:
  • id (basestring) – id path parameter. Id of reserve ip subpool to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reserve_ip_subpool(site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv4GlobalPool=None, ipv4Prefix=None, ipv4PrefixLength=None, ipv4Subnet=None, ipv4TotalHost=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to reserve an ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv4GateWay (string) – Network Settings’s Gateway ip address details, example: 175.175.0.1 .

  • ipv4GlobalPool (string) – Network Settings’s IP v4 Global pool address with cidr, example: 175.175.0.0/16 .

  • ipv4Prefix (boolean) – Network Settings’s IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable .

  • ipv4PrefixLength (integer) – Network Settings’s The ipv4 prefix length is required when ipv4prefix value is true. .

  • ipv4Subnet (string) – Network Settings’s IPv4 Subnet address, example: 175.175.0.0 .

  • ipv4TotalHost (integer) – Network Settings’s IPv4 total host is required when ipv4prefix value is false. .

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • type (string) – Network Settings’s Type of the reserve ip sub pool . Available values are ‘Generic’, ‘LAN’, ‘WAN’, ‘management’ and ‘service’.

  • site_id (basestring) – siteId path parameter. Site id to reserve the ip sub pool. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_reserve_ip_subpool(id, site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv4GateWay (string) – Network Settings’s Ipv4 Gate Way.

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IP v6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s IPv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • site_id (basestring) – siteId path parameter. Site id of site to update sub pool. .

  • id (basestring) – id query parameter. Id of subpool to be associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS). .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create service provider profile(QOS). .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update SP profile .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS). .

Parameters:
  • sp_profile_name (basestring) – spProfileName path parameter. sp profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 2.2.3.3).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters. .

Parameters:
  • periodic_refresh (bool) – periodicRefresh query parameter. Is analysis periodically refreshed? .

  • source_ip (basestring) – sourceIP query parameter. Source IP address .

  • dest_ip (basestring) – destIP query parameter. Destination IP adress .

  • source_port (basestring) – sourcePort query parameter. Source port .

  • dest_port (basestring) – destPort query parameter. Destination port .

  • gt_create_time (basestring) – gtCreateTime query parameter. Analyses requested after this time .

  • lt_create_time (basestring) – ltCreateTime query parameter. Analyses requested before this time .

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – taskId query parameter. Task ID .

  • last_update_time (basestring) – lastUpdateTime query parameter. Last update time .

  • limit (basestring) – limit query parameter. Number of resources returned .

  • offset (basestring) – offset query parameter. Start index of resources returned (1-based) .

  • order (basestring) – order query parameter. Order by this field .

  • sort_by (basestring) – sortBy query parameter. Sort by this field .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress. .

Parameters:
  • controlPath (boolean) – Path Trace’s controlPath.

  • destIP (string) – Path Trace’s destIP.

  • destPort (string) – Path Trace’s destPort.

  • inclusions (list) – Path Trace’s inclusions (list of strings).

  • periodicRefresh (boolean) – Path Trace’s periodicRefresh.

  • protocol (string) – Path Trace’s protocol.

  • sourceIP (string) – Path Trace’s sourceIP.

  • sourcePort (string) – Path Trace’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

platform_configuration

class PlatformConfiguration[source]

Cisco DNA Center Platform Configuration API (version: 2.2.3.3).

Wraps the DNA Center Platform Configuration API and exposes the API as native Python methods that return native Python objects.

release_summary(headers=None, **request_parameters)[source]

Provides information such as API version, mandatory core packages for installation or upgrade, optional packages, Cisco DNA Center name and version, supported direct updates, and tenant ID. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nodes_configuration_summary(headers=None, **request_parameters)[source]

Provides details about the current Cisco DNA Center node configuration, such as API version, node name, NTP server, intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default gateway, and interface information. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

policy

class Policy[source]

Cisco DNA Center Policy API (version: 2.2.3.3).

Wraps the DNA Center Policy API and exposes the API as native Python methods that return native Python objects.

create_a_profiling_rule(clusterId=None, conditionGroups=None, isDeleted=None, lastModifiedBy=None, lastModifiedOn=None, pluginId=None, rejected=None, result=None, ruleId=None, ruleName=None, rulePriority=None, ruleType=None, ruleVersion=None, sourcePriority=None, usedAttributes=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates profiling rule from the request body. .

Parameters:
  • clusterId (string) – Policy’s Unique identifier for ML cluster. Only applicable for ‘ML Rule’. .

  • conditionGroups (object) – Policy’s conditionGroups.

  • isDeleted (boolean) – Policy’s Flag to indicate whether the rule was deleted. .

  • lastModifiedBy (string) – Policy’s User that last modified the rule. It is read-only, and is ignored if provided as part of input request. .

  • lastModifiedOn (integer) – Policy’s Timestamp (in epoch milliseconds) of last modification. It is read- only, and is ignored if provided as part of input request. .

  • pluginId (string) – Policy’s Plugin for the rule. Only applicable for ‘Cisco Default’ rules. .

  • rejected (boolean) – Policy’s Flag to indicate whether rule has been rejected by user or not. Only applicable for ‘ML Rule’. .

  • result (object) – Policy’s result.

  • ruleId (string) – Policy’s Unique identifier for the rule. This is normally generated by the system, and client does not need to provide it for rules that need to be newly created. .

  • ruleName (string) – Policy’s Human readable name for the rule. .

  • rulePriority (integer) – Policy’s Priority for the rule. .

  • ruleType (string) – Policy’s Type of the rule. Allowed values are ‘Cisco Default Static’, ‘Cisco Default Dynamic’, ‘Custom Rule’, ‘ML Rule’. .

  • ruleVersion (integer) – Policy’s Version of the rule. .

  • sourcePriority (integer) – Policy’s Source priority for the rule. .

  • usedAttributes (list) – Policy’s List of attributes used in the rule. Only applicable for ‘Cisco Default’ rules. (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_profiling_rules(include_deleted=None, limit=None, offset=None, order=None, rule_type=None, sort_by=None, headers=None, **request_parameters)[source]

This API fetches the list of profiling rules. It can be used to show profiling rules in client applications, or export those from an environment. ‘POST /profiling-rules/bulk’ API can be used to import such exported rules into another environment. If this API is used to export rules to be imported into another Cisco DNA Center system, then ensure that ‘includeDeleted’ parameter is ‘true’, so that deleted rules get synchronized correctly. Use query parameters to filter the data, as required. If no filter is provided, then it will include only rules of type ‘Custom Rule’ in the response. By default, the response is limited to 500 records. Use ‘limit’ parameter to fetch higher number of records, if required. ‘GET /profiling-rules/count’ API can be used to find out the total number of rules in the system. .

Parameters:
  • rule_type (basestring) – ruleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. .

  • include_deleted (bool) – includeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. .

  • limit (int) – limit query parameter. Maximum number of records to be fetched. If not provided, 500 records will be fetched by default. To fetch all the records in the system, provide a large value for this parameter. .

  • offset (int) – offset query parameter. Record offset to start data fetch at. Offset starts at zero. .

  • sort_by (basestring) – sortBy query parameter. Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. .

  • order (basestring) – order query parameter. Order to be used for sorting. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_profiling_rules_in_bulk(profilingRules=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API imports the given list of profiling rules. For each record, 1) If ‘ruleType’ for a record is not ‘Custom Rule’, then it is rejected. 2) If ‘ruleId’ is provided in the input record, 2a) Record with same ‘ruleId’ exists in the system, then it is replaced with new data. 2b) Record with same ‘ruleId’ does not exist, then it is inserted in the database. 3) If ‘ruleId’ is not provided in the input record, then new ‘ruleId’ is generated by the system, and record is inserted. .

Parameters:
  • profilingRules (list) – Policy’s profilingRules (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_count_of_profiling_rules(include_deleted=None, rule_type=None, headers=None, **request_parameters)[source]

This API fetches the count of profiling rules based on the filter values provided in the query parameters. The filter parameters are same as that of ‘GET /profiling-rules’ API, excluding the pagination and sort parameters. .

Parameters:
  • rule_type (basestring) – ruleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to ‘Custom Rule’. .

  • include_deleted (bool) – includeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_an_existing_profiling_rule(rule_id, clusterId=None, conditionGroups=None, isDeleted=None, lastModifiedBy=None, lastModifiedOn=None, pluginId=None, rejected=None, result=None, ruleId=None, ruleName=None, rulePriority=None, ruleType=None, ruleVersion=None, sourcePriority=None, usedAttributes=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the profiling rule for the given ‘ruleId’. .

Parameters:
  • clusterId (string) – Policy’s Unique identifier for ML cluster. Only applicable for ‘ML Rule’. .

  • conditionGroups (object) – Policy’s conditionGroups.

  • isDeleted (boolean) – Policy’s Flag to indicate whether the rule was deleted. .

  • lastModifiedBy (string) – Policy’s User that last modified the rule. It is read-only, and is ignored if provided as part of input request. .

  • lastModifiedOn (integer) – Policy’s Timestamp (in epoch milliseconds) of last modification. It is read- only, and is ignored if provided as part of input request. .

  • pluginId (string) – Policy’s Plugin for the rule. Only applicable for ‘Cisco Default’ rules. .

  • rejected (boolean) – Policy’s Flag to indicate whether rule has been rejected by user or not. Only applicable for ‘ML Rule’. .

  • result (object) – Policy’s result.

  • ruleId (string) – Policy’s Unique identifier for the rule. This is normally generated by the system, and client does not need to provide it for rules that need to be newly created. .

  • ruleName (string) – Policy’s Human readable name for the rule. .

  • rulePriority (integer) – Policy’s Priority for the rule. .

  • ruleType (string) – Policy’s Type of the rule. Allowed values are ‘Cisco Default Static’, ‘Cisco Default Dynamic’, ‘Custom Rule’, ‘ML Rule’. .

  • ruleVersion (integer) – Policy’s Version of the rule. .

  • sourcePriority (integer) – Policy’s Source priority for the rule. .

  • usedAttributes (list) – Policy’s List of attributes used in the rule. Only applicable for ‘Cisco Default’ rules. (list of strings).

  • rule_id (basestring) – ruleId path parameter. Unique rule identifier .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_details_of_a_single_profiling_rule(rule_id, headers=None, **request_parameters)[source]

Fetches details of the profiling rule for the given ‘ruleId’. .

Parameters:
  • rule_id (basestring) – ruleId path parameter. Unique rule identifier .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_an_existing_profiling_rule(rule_id, headers=None, **request_parameters)[source]

Deletes the profiling rule for the given ‘ruleId’. .

Parameters:
  • rule_id (basestring) – ruleId path parameter. Unique rule identifier .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reports

class Reports[source]

Cisco DNA Center Reports API (version: 2.2.3.3).

Wraps the DNA Center Reports API and exposes the API as native Python methods that return native Python objects.

create_or_schedule_a_report(deliveries=None, name=None, schedule=None, tags=None, view=None, viewGroupId=None, viewGroupVersion=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Schedule a report configuration. Use “Get view details for a given view group & view” API to get the metadata required to configure a report. .

Parameters:
  • deliveries (list) – Reports’s Array of available delivery channels (list of objects).

  • name (string) – Reports’s report name .

  • schedule (object) – Reports’s schedule.

  • tags (list) – Reports’s array of tags for report (list of strings).

  • view (object) – Reports’s view.

  • viewGroupId (string) – Reports’s viewGroupId of the viewgroup for the report .

  • viewGroupVersion (string) – Reports’s version of viewgroup for the report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_scheduled_reports(view_group_id=None, view_id=None, headers=None, **request_parameters)[source]

Get list of scheduled report configurations. .

Parameters:
  • view_group_id (basestring) – viewGroupId query parameter. viewGroupId of viewgroup for report .

  • view_id (basestring) – viewId query parameter. viewId of view for report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Get scheduled report configuration by reportId .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Delete a scheduled report configuration. Deletes the report executions also. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_execution_details_for_a_given_report(report_id, headers=None, **request_parameters)[source]

Get details of all executions for a given report .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_report_content(execution_id, report_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • execution_id (basestring) – executionId path parameter. executionId of report execution .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

get_all_view_groups(headers=None, **request_parameters)[source]

Gives a list of summary of all view groups. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_views_for_a_given_view_group(view_group_id, headers=None, **request_parameters)[source]

Gives a list of summary of all views in a viewgroup. Use “Get all view groups” API to get the viewGroupIds (required as a query param for this API) for available viewgroups. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_view_details_for_a_given_view_group_and_view(view_group_id, view_id, headers=None, **request_parameters)[source]

Gives complete information of the view that is required to configure a report. Use “Get views for a given view group” API to get the viewIds (required as a query param for this API) for available views. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup .

  • view_id (basestring) – viewId path parameter. view id of view .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sda

class Sda[source]

Cisco DNA Center SDA API (version: 2.2.3.3).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

get_default_authentication_profile(site_name_hierarchy, authenticate_template_name=None, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • authenticate_template_name (basestring) – authenticateTemplateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(authenticateTemplateName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deploy authentication template in SDA Fabric .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate Template Name. Allowed values are ‘No Authentication ‘, ‘Open Authentication’, ‘Closed Authentication’, ‘Low Impact’. .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy should be a valid fabric site name hierarchy. e.g Global/USA/San Jose .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(authenticateTemplateName=None, authenticationOrder=None, dot1xToMabFallbackTimeout=None, numberOfHosts=None, siteNameHierarchy=None, wakeOnLan=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate Template Name. Allowed values are ‘Open Authentication’, ‘Closed Authentication’, ‘No Authentication’, ‘Low Impact’. .

  • authenticationOrder (string) – SDA’s Authentication Order. Allowed values are ‘dot1x ‘, ‘mac’. .

  • dot1xToMabFallbackTimeout (string) – SDA’s In a network that includes both devices that support and devices that do not support IEEE 802.1X, MAB can be deployed as a fallback, or complementary, mechanism to IEEE 802.1X. If the network does not have any IEEE 802.1X-capable devices, MAB can be deployed as a standalone authentication mechanism (e.g. [3-120]) .

  • numberOfHosts (string) – SDA’s Number of hosts specifies the number of data hosts that can be connected to a port. With Single selected, you can have only one data client on the port. With Unlimited selected, you can have multiple data clients and one voice client on the port . Available values are ‘Unlimited’ and ‘Single’.

  • siteNameHierarchy (string) – SDA’s siteNameHierarchy should be a valid fabric site name hierarchy. e.g Global/USA/San Jose .

  • wakeOnLan (boolean) – SDA’s The IEEE 802.1X Wake on LAN (WoL) Support feature allows dormant systems to be powered up when the switch receives a specific Ethernet frame. You can use this feature in cases when hosts on power save and needs to receive a magic packet to turn them on. This feature works on a per subnet basis and send the subnet broadcast to all hosts in the subnet .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Add default authentication profile in SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(borderSessionType=None, connectedToInternet=None, deviceManagementIpAddress=None, externalAutonomouSystemNumber=None, externalConnectivityIpPoolName=None, externalConnectivitySettings=None, externalDomainRoutingProtocolName=None, interfaceName=None, internalAutonomouSystemNumber=None, l3Handoff=None, siteNameHierarchy=None, virtualNetwork=None, virtualNetworkName=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds border device in SDA Fabric .

Parameters:
  • borderSessionType (string) – SDA’s Border Session Type . Available values are ‘EXTERNAL’, ‘INTERNAL’ and ‘ANYWHERE’.

  • connectedToInternet (boolean) – SDA’s Connected to Internet .

  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

  • externalAutonomouSystemNumber (string) – SDA’s External Autonomous System Number will be used to automate IP routing between Border Node and remote peer (e.g.,1-65535) .

  • externalConnectivityIpPoolName (string) – SDA’s IP pool to use to automate IP routing between the border node and remote peer. .

  • externalConnectivitySettings (object) – SDA’s External Connectivity Settings information of L3 Handoff .

  • externalDomainRoutingProtocolName (string) – SDA’s External Domain Routing Protocol Name. (Example: BGP) .

  • interfaceName (string) – SDA’s Interface Name .

  • internalAutonomouSystemNumber (string) – SDA’s Internal Autonomouns System Number used by border node to communicate with remote peer (e.g.,1-65535) .

  • l3Handoff (object) – SDA’s L3 Handoff information .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy for device location(site should be fabric site) .

  • virtualNetwork (object) – SDA’s Virtual Network information of L3 Hand off .

  • virtualNetworkName (string) – SDA’s Virtual Network Name assigned to site .

  • vlanId (string) – SDA’s Vlan Id (e.g.,2-4096 except for reserved VLANs (1002-1005, 2046, 4095)) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_management_ip_address, headers=None, **request_parameters)[source]

Gets border device detail from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_management_ip_address, headers=None, **request_parameters)[source]

Deletes border device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_control_plane_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_control_plane_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_control_plane_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy of provisioned Device(site should be fabric site) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_info(device_management_ip_address, headers=None, **request_parameters)[source]

Get device info from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_role_in_sda_fabric(device_management_ip_address, headers=None, **request_parameters)[source]

Get device role in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Device Management IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy of provisioned Device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sda_fabric(fabric_name, headers=None, **request_parameters)[source]

Delete SDA Fabric .

Parameters:
  • fabric_name (basestring) – fabricName query parameter. Fabric Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_info(fabric_name, headers=None, **request_parameters)[source]

Get SDA Fabric Info .

Parameters:
  • fabric_name (basestring) – fabricName query parameter. Fabric Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_fabric(fabricName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SDA Fabric .

Parameters:
  • fabricName (string) – SDA’s Fabric Name (from DNAC2.2.3 onwards following default fabric name Default_LAN_Fabric) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_site(fabricName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric .

Parameters:
  • fabricName (string) – SDA’s Fabric Name (should be existing fabric name) .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy for provision device location. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sda_fabric_count(headers=None, **request_parameters)[source]

Get SDA Fabric Count .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_access_point(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated to siteNameHierarchy. .

  • dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to INFRA_VN .

  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the edge device .

  • interfaceDescription (string) – SDA’s Details or note of interface assignment .

  • interfaceName (string) – SDA’s Interface Name of the edge device .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy should be a valid fabric site name hierarchy. e.g Global/USA/San Jose .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, scalableGroupName=None, siteNameHierarchy=None, voiceIpAddressPoolName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric. .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated to siteNameHierarchy. Allowed values are ‘Open Authentication’, ‘Closed Authentication’, ‘Low Impact’, ‘No Authentication’, ‘’. . Available values are ‘Open Authentication’, ‘Closed Authentication’, ‘Low Impact’, ‘No Authentication’ and ‘’.

  • dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as DATA(can’t be empty if voiceIpAddressPoolName is empty) .

  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the edge device .

  • interfaceDescription (string) – SDA’s Details or note of interface assignment .

  • interfaceName (string) – SDA’s Interface Name of the edge device .

  • scalableGroupName (string) – SDA’s valid name of a scalable group associated with virtual network(Scalable groups are only supported on No Auth profile because the other profiles assign SGTs from ISE) .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy should be a valid fabric site name hierarchy. e.g Global/USA/San Jose .

  • voiceIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as VOICE(can’t be empty if dataIpAddressPoolName is emty) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_multicast_in_sda_fabric(multicastMethod=None, multicastVnInfo=None, muticastType=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add multicast in SDA fabric .

Parameters:
  • multicastMethod (string) – SDA’s Multicast Methods . Available values are ‘native_multicast’ and ‘’.

  • multicastVnInfo (object) – SDA’s multicastVnInfo.

  • muticastType (string) – SDA’s Muticast Type . Available values are ‘ssm’, ‘asm_with_external_rp’ and ‘’.

  • siteNameHierarchy (string) – SDA’s Full path of sda fabric siteNameHierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_multicast_details_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)[source]

Get multicast details from SDA fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. fabric site name hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_multicast_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete multicast from SDA fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Valid IP address of the device currently provisioned in a fabric site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

re_provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Re-Provision Wired Device .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be re-provisioned .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy for device location(only building / floor level) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision Wired Device .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be provisioned .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy for device location(only building / floor level) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get Provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_vn(siteNameHierarchy=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy should be a valid fabric site name hierarchy.( e.g. Global/USA/San Jose) .

  • virtualNetworkName (string) – SDA’s Virtual Network Name, that is created in Global level .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network .

Parameters:
  • ip_pool_name (basestring) – ipPoolName query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(authenticationPolicyName=None, ipPoolName=None, isL2FloodingEnabled=None, isThisCriticalPool=None, isWirelessPool=None, poolType=None, scalableGroupName=None, siteNameHierarchy=None, trafficType=None, virtualNetworkName=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network .

Parameters:
  • authenticationPolicyName (string) – SDA’s Deprecated, same as vlanName, please use vlanName .

  • ipPoolName (string) – SDA’s Ip Pool Name, that is reserved to fabric siteNameHierarchy .

  • isL2FloodingEnabled (boolean) – SDA’s Layer2 flooding enablement flag .

  • isThisCriticalPool (boolean) – SDA’s Critical pool enablement flag where depending on the pool type (data or voice), a corresponding Critical Vlan gets assigned to the Critical Pool .

  • isWirelessPool (string) – SDA’s Wireless Pool enablement flag .

  • poolType (string) – SDA’s Pool Type (needed when assigning segment to INFRA_VN) (Example: AP.) .

  • scalableGroupName (string) – SDA’s Scalable Group, that is associated to Virtual Network .

  • siteNameHierarchy (string) – SDA’s Full path of sda fabric siteNameHierarchy .

  • trafficType (string) – SDA’s Traffic type . Available values are ‘data’ and ‘voice’.

  • virtualNetworkName (string) – SDA’s Virtual Network Name, that is associated to fabric siteNameHierarchy .

  • vlanName (string) – SDA’s Vlan name for this segment, represent the segment name, if empty, vlanName would be auto generated by API .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, virtualNetworkName=None, virtualNetworkType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network with scalable groups at global level .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s To create guest virtual network .

  • scalableGroupNames (list) – SDA’s Scalable Group to be associated to virtual network (list of strings).

  • virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned global level .

  • virtualNetworkType (string) – SDA’s Virtual Network Type.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, virtualNetworkName=None, virtualNetworkType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update virtual network with scalable groups .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s To create guest virtual network .

  • scalableGroupNames (list) – SDA’s Scalable Group to be associated to virtual network (list of strings).

  • virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned global level .

  • virtualNetworkType (string) – SDA’s Virtual Network Type.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

security_advisories

class SecurityAdvisories[source]

Cisco DNA Center Security Advisories API (version: 2.2.3.3).

Wraps the DNA Center Security Advisories API and exposes the API as native Python methods that return native Python objects.

get_advisories_list(headers=None, **request_parameters)[source]

Retrieves list of advisories on the network .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_summary(headers=None, **request_parameters)[source]

Retrieves summary of advisories on the network. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_per_advisory(advisory_id, headers=None, **request_parameters)[source]

Retrieves list of devices for an advisory .

Parameters:
  • advisory_id (basestring) – advisoryId path parameter. Advisory ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisory_ids_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisory IDs for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisories for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors

class Sensors[source]

Cisco DNA Center Sensors API (version: 2.2.3.3).

Wraps the DNA Center Sensors API and exposes the API as native Python methods that return native Python objects.

edit_sensor_test_template(locationInfoList=None, schedule=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to deploy, schedule, or edit and existing SENSOR test template .

Parameters:
  • locationInfoList (list) – Sensors’s locationInfoList (list of objects).

  • schedule (object) – Sensors’s schedule.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sensor_test_template(apCoverage=None, connection=None, modelVersion=None, name=None, ssids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID .

Parameters:
  • apCoverage (list) – Sensors’s apCoverage (list of objects).

  • connection (string) – Sensors’s Connection.

  • modelVersion (integer) – Sensors’s Model Version.

  • name (string) – Sensors’s Name.

  • ssids (list) – Sensors’s ssids (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sensor_test(template_name=None, headers=None, **request_parameters)[source]

Intent API to delete an existing SENSOR test template .

Parameters:
  • template_name (basestring) – templateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors(site_id=None, headers=None, **request_parameters)[source]

Intent API to get a list of SENSOR devices .

Parameters:
  • site_id (basestring) – siteId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_now_sensor_test(templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to run a deployed SENSOR test .

Parameters:
  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

duplicate_sensor_test_template(newTemplateName=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to duplicate an existing SENSOR test template .

Parameters:
  • newTemplateName (string) – Sensors’s New Template Name.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 2.2.3.3).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor . .

Parameters:
  • provisioning (list) – Site Design’s provisioning (list of objects).

  • siteProfile (list) – Site Design’s siteProfile (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address. .

Parameters:
  • device_ip (basestring) – deviceIp query parameter. Device to which the provisioning detail has to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

associate(network_profile_id, site_id, headers=None, **request_parameters)[source]

Associate Site to a Network Profile .

Parameters:
  • network_profile_id (basestring) – networkProfileId path parameter. Network-Profile Id to be associated .

  • site_id (basestring) – siteId path parameter. Site Id to be associated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

disassociate(network_profile_id, site_id, headers=None, **request_parameters)[source]

Disassociate a Site from a Network Profile .

Parameters:
  • network_profile_id (basestring) – networkProfileId path parameter. Network-Profile Id to be associated .

  • site_id (basestring) – siteId path parameter. Site Id to be associated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information. .

Parameters:
  • device_ip (string) – Site Design’s Device Ip.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network profile for different NFV topologies .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • profileName (string) – Site Design’s Name of the profile to create NFV profile .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a NFV Network profile .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • id (basestring) – id path parameter. Id of the NFV profile to be updated .

  • name (basestring) – name query parameter. Name of the profile to be updated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

API to get NFV network profile. .

Parameters:
  • id (basestring) – id path parameter. ID of network profile to retrieve. .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. Number of profile to be retrieved .

  • name (basestring) – name query parameter. Name of network profile to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_nfv_profile(id, name=None, headers=None, **request_parameters)[source]

API to delete nfv network profile. .

Parameters:
  • id (basestring) – id path parameter. Id of nfv network profile to delete. .

  • name (basestring) – name query parameter. Nameof nfv network profile to delete. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_floormap(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Service to create a floor map with callback .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_floormaps(headers=None, **request_parameters)[source]

List all floor maps .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_floormap(floor_id, headers=None, **request_parameters)[source]

Service to delete an (empty) floor map with callback .

Parameters:
  • floor_id (basestring) – floorId path parameter. Group ID of floor to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_floormap(floor_id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Service to create a floor map with callback .

Parameters:
  • floor_id (basestring) – floorId path parameter. Group ID of the floor to be modified .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_floormap(floor_id, headers=None, **request_parameters)[source]

List specified floor map(s) .

Parameters:
  • floor_id (basestring) – floorId path parameter. Group Id of the specified floormap .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 2.2.3.3).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

get_membership(site_id, device_family=None, limit=None, offset=None, serial_number=None, headers=None, **request_parameters)[source]

Getting the site children details and device details. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to retrieve device associated with the site. .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. Number of sites to be retrieved .

  • device_family (basestring) – deviceFamily query parameter. Device family name .

  • serial_number (basestring) – serialNumber query parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy. .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type of site to create (eg: area, building, floor) . Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site using siteNameHierarchy/siteId/type ,return all sites if these parameters are not given as input. .

Parameters:
  • name (basestring) – name query parameter. siteNameHierarchy (ex: global/groupName) .

  • site_id (basestring) – siteId query parameter. Site id to which site details to retrieve. .

  • type (basestring) – type query parameter. type (ex: area, building, floor) .

  • offset (basestring) – offset query parameter. offset/starting row .

  • limit (basestring) – limit query parameter. Number of sites to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(limit=None, offset=None, site_type=None, timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required .

  • site_type (basestring) – siteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA .

  • offset (int) – offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. .

  • limit (int) – limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve site count. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – siteId path parameter. Site id to which site details to be updated. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to which site details to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

assign_device_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns list of devices to a site .

Parameters:
  • device (list) – Sites’s device (list of objects).

  • site_id (basestring) – siteId path parameter. Site id to which site the device to assign .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 2.2.3.3).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash .

Parameters:
  • schedule_validate (bool) – scheduleValidate query parameter. scheduleValidate, validates data before schedule (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order=None, version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%” .

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus query parameter. imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED .

  • version (basestring) – version query parameter. software Image Version .

  • image_series (basestring) – imageSeries query parameter. image Series .

  • image_name (basestring) – imageName query parameter. image Name .

  • is_tagged_golden (bool) – isTaggedGolden query parameter. is Tagged Golden .

  • is_cco_recommended (bool) – isCCORecommended query parameter. is recommended from cisco.com .

  • is_cco_latest (bool) – isCCOLatest query parameter. is latest from cisco.com .

  • created_time (int) – createdTime query parameter. time in milliseconds (epoch format) .

  • image_size_greater_than (int) – imageSizeGreaterThan query parameter. size in bytes .

  • image_size_lesser_than (int) – imageSizeLesserThan query parameter. size in bytes .

  • sort_by (basestring) – sortBy query parameter. sort results by this field .

  • sort_order (basestring) – sortOrder query parameter. sort order ‘asc’ or ‘des’. Default is asc .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_family_identifiers(headers=None, **request_parameters)[source]

API to get Device Family Identifiers for all Device Families that can be used for tagging an image golden. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag_as_golden_image(deviceFamilyIdentifier=None, deviceRole=None, imageId=None, siteId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Golden Tag image. Set siteId as -1 for Global site. .

Parameters:
  • deviceFamilyIdentifier (string) – Software Image Management (SWIM)’s Device Family Identifier e.g. : 277696480-283933147, 277696480 .

  • deviceRole (string) – Software Image Management (SWIM)’s Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • imageId (string) – Software Image Management (SWIM)’s imageId in uuid format. .

  • siteId (string) – Software Image Management (SWIM)’s SiteId in uuid format. For Global Site “-1” to be used. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_golden_tag_for_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)[source]

Remove golden tag. Set siteId as -1 for Global site. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

  • device_family_identifier (basestring) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

  • device_role (basestring) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • image_id (basestring) – imageId path parameter. Image Id in uuid format. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_golden_tag_status_of_an_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)[source]

Get golden tag status of an image. Set siteId as -1 for Global site. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

  • device_family_identifier (basestring) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

  • device_role (basestring) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • image_id (basestring) – imageId path parameter. Image Id in uuid format. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2. Upload the file to the file form data field .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – isThirdParty query parameter. Third party Image check .

  • third_party_vendor (basestring) – thirdPartyVendor query parameter. Third Party Vendor .

  • third_party_image_family (basestring) – thirdPartyImageFamily query parameter. Third Party image family .

  • third_party_application_type (basestring) – thirdPartyApplicationType query parameter. Third Party Application Type .

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2 .

Parameters:
  • schedule_at (basestring) – scheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – scheduleDesc query parameter. Custom Description (Optional) .

  • schedule_origin (basestring) – scheduleOrigin query parameter. Originator of this call (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 2.2.3.3).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria .

Parameters:
  • name (basestring) – name query parameter. Tag name is mandatory when filter operation is used. .

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • field (basestring) – field query parameter. Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’ .

  • sort_by (basestring) – sortBy query parameter. Only supported attribute is name. SortyBy is mandatory when order is used. .

  • order (basestring) – order query parameter. Available values are asc and des .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count .

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API .

Parameters:
  • memberToTags (list) – Tag’s memberToTags (list of objects).

  • memberType (string) – Tag’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level=None, limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API .

  • offset (basestring) – offset query parameter. Used for pagination. It indicates the starting row number out of available member records .

  • limit (basestring) – limit query parameter. Used to Number of maximum members to return in the result .

  • member_association_type (basestring) – memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag .

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_members_to_the_tag(id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level=None, member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_id (basestring) – memberId path parameter. TagMember id to be removed from tag .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 2.2.3.3).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_business_api_execution_details(execution_id, headers=None, **request_parameters)[source]

Retrieves the execution details of a Business API .

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution Id of API .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • offset (basestring) – offset query parameter.

  • limit (basestring) – limit query parameter.

  • sort_by (basestring) – sortBy query parameter. Sort results by this field .

  • order (basestring) – order query parameter. Sort order asc or dsc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid .

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – offset path parameter. Index, minimum value is 0 .

  • limit (int) – limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 2.2.3.3).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Network health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID .

Parameters:
  • vlan_id (basestring) – vlanID path parameter. Vlan Name for e.g Vlan1, Vlan23 etc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol .

Parameters:
  • topology_type (basestring) – topologyType path parameter. Type of topology(OSPF,ISIS,etc) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType .

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 2.2.3.3).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 2.2.3.3).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

sensor_test_results(end_time=None, site_id=None, start_time=None, test_failure_by=None, headers=None, **request_parameters)[source]

Intent API to get SENSOR test result summary .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID .

  • start_time (int) – startTime query parameter. The epoch time in milliseconds .

  • end_time (int) – endTime query parameter. The epoch time in milliseconds .

  • test_failure_by (basestring) – testFailureBy query parameter. Obtain failure statistics group by “area”, “building”, or “floor” .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites .

Parameters:
  • enableFabric (boolean) – Wireless’s Enable SSID for Fabric .

  • flexConnect (object) – Wireless’s flexConnect.

  • managedAPLocations (list) – Wireless’s Managed AP Locations (Enter entire Site(s) hierarchy) (list of strings).

  • ssidDetails (object) – Wireless’s ssidDetails.

  • ssidType (string) – Wireless’s SSID Type . Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center .

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName query parameter. Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout .

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcast SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service .

  • enableFastLane (boolean) – Wireless’s Enable Fast Lane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List .

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client . Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s Enter SSID Name .

  • passphrase (string) – Wireless’s Pass Phrase (Only applicable for SSID with PERSONAL security level) .

  • radioPolicy (string) – Wireless’s Radio Policy. Allowed values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’, ‘2.4GHz only’. .

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout .

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcast SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service .

  • enableFastLane (boolean) – Wireless’s Enable Fast Lane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List .

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client . Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s Enter SSID Name .

  • passphrase (string) – Wireless’s Pass Phrase (Only applicable for SSID with PERSONAL security level) .

  • radioPolicy (string) – Wireless’s Radio Policy. Allowed values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’, ‘2.4GHz only’ .

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’ and ‘OPEN’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName path parameter. Enter the SSID name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from DNAC whose name is provided. .

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter. Wireless Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Access Point Provision and ReProvision .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_dynamic_interface(interfaceName=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create or update an dynamic interface .

Parameters:
  • interfaceName (string) – Wireless’s dynamic-interface name .

  • vlanId (number) – Wireless’s Vlan Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_dynamic_interface(interface_name=None, headers=None, **request_parameters)[source]

Get one or all dynamic interface(s) .

Parameters:
  • interface_name (basestring) – interface-name query parameter. dynamic-interface name, if not specified all the existing dynamic interfaces will be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_dynamic_interface(interface_name, headers=None, **request_parameters)[source]

Delete a dynamic interface .

Parameters:
  • interface_name (basestring) – interfaceName path parameter. valid interface-name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile. .

Parameters:
  • profile_name (basestring) – profileName query parameter. Wireless Network Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

psk_override(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update/override pass phrase of enterprise SSID .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles .

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile .

Parameters:
  • channelWidth (string) – Wireless’s rf-profile channel width .

  • defaultRfProfile (boolean) – Wireless’s isDefault rf-profile .

  • enableBrownField (boolean) – Wireless’s true if enable brown field for rf-profile else false .

  • enableCustom (boolean) – Wireless’s true if enable custom rf-profile else false .

  • enableRadioTypeA (boolean) – Wireless’s tru if Enable Radio Type A else false .

  • enableRadioTypeB (boolean) – Wireless’s true if Enable Radio Type B else false .

  • name (string) – Wireless’s custom RF profile name .

  • radioTypeAProperties (object) – Wireless’s radioTypeAProperties.

  • radioTypeBProperties (object) – Wireless’s radioTypeBProperties.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s) .

Parameters:
  • rf_profile_name (basestring) – rfProfileName path parameter. RF profile name to be deleted(required) non- custom RF profile cannot be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v2.3.3.0

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 2.3.3.0).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_application_policy(policy_scope=None, headers=None, **request_parameters)[source]

Get all existing application policies .

Parameters:
  • policy_scope (basestring) – policyScope query parameter. policy scope name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_policy_default(headers=None, **request_parameters)[source]

Get default application policy .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

application_policy_intent(createList=None, deleteList=None, updateList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Update/Delete application policy .

Parameters:
  • createList (list) – Application Policy’s createList (list of objects).

  • deleteList (list) – Application Policy’s Delete list of Group Based Policy ids (list of strings).

  • updateList (list) – Application Policy’s updateList (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_policy_queuing_profile(name=None, headers=None, **request_parameters)[source]

Get all or by name, existing application policy queuing profiles .

Parameters:
  • name (basestring) – name query parameter. queuing profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update existing custom application queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_policy_queuing_profile_count(headers=None, **request_parameters)[source]

Get the number of all existing application policy queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_policy_queuing_profile(id, headers=None, **request_parameters)[source]

Delete existing custom application policy queuing profile by id .

Parameters:
  • id (basestring) – id path parameter. Id of custom queuing profile to delete .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name .

Parameters:
  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id .

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id .

Parameters:
  • id (basestring) – id query parameter. Application’s Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name .

Parameters:
  • offset (basestring, int) – offset query parameter. The offset of the first application to be returned .

  • limit (basestring, int) – limit query parameter. The maximum number of applications to be returned .

  • name (basestring) – name query parameter. Application’s name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_qos_device_interface_info(network_device_id=None, headers=None, **request_parameters)[source]

Get all or by network device id, existing qos device interface infos .

Parameters:
  • network_device_id (basestring) – networkDeviceId query parameter. network device id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update existing qos device interface infos associate with network device id .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create qos device interface infos associate with network device id to allow the user to mark specific interfaces as WAN, to associate WAN interfaces with specific SP Profile and to be able to define a shaper on WAN interfaces .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_qos_device_interface_info_count(headers=None, **request_parameters)[source]

Get the number of all existing qos device interface infos group by network device id .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_qos_device_interface_info(id, headers=None, **request_parameters)[source]

Delete all qos device interface infos associate with network device id .

Parameters:
  • id (basestring) – id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

applications

class Applications[source]

Cisco DNA Center Applications API (version: 2.3.3.0).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications(application_health=None, application_name=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of applications for a specific site, a device, or a client device’s MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints. .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac) .

  • device_id (basestring) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac) .

  • mac_address (basestring) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId) .

  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window .

  • application_health (basestring) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) .

  • offset (basestring, int) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) .

  • limit (basestring, int) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) .

  • application_name (basestring) – applicationName query parameter. The name of the application to get information on .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

cisco_dna_center_system

class CiscoDnaCenterSystem[source]

Cisco DNA Center Cisco DNA Center System API (version: 2.3.3.0).

Wraps the DNA Center Cisco DNA Center System API and exposes the API as native Python methods that return native Python objects.

authorize_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Authorizes one of more devices. A device can only be authorized if Authorization is set in Device Settings. .

Parameters:
  • deviceIdList (list) – Cisco DNA Center System’s Device Id List (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clients

class Clients[source]

Cisco DNA Center Clients API (version: 2.3.3.0).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • mac_address (basestring) – macAddress query parameter. MAC Address of the client .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

client_proximity(username, number_days=None, time_resolution=None, headers=None, **request_parameters)[source]

This intent API will provide client proximity information for a specific wireless user. Proximity is defined as presence on the same floor at the same time as the specified wireless user. The Proximity workflow requires the subscription to the following event (via the Event Notification workflow) prior to making this API call: NETWORK-CLIENTS-3-506 Client Proximity Report. .

Parameters:
  • username (basestring) – username query parameter. Wireless client username for which proximity information is required .

  • number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days. .

  • time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 2.3.3.0).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs .

Parameters:
  • commands (list) – Command Runner’s commands (list of strings).

  • description (string) – Command Runner’s description.

  • deviceUuids (list) – Command Runner’s deviceUuids (list of strings).

  • name (string) – Command Runner’s name.

  • timeout (integer) – Command Runner’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

compliance

class Compliance[source]

Cisco DNA Center Compliance API (version: 2.3.3.0).

Wraps the DNA Center Compliance API and exposes the API as native Python methods that return native Python objects.

get_compliance_status_(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (basestring, int) – offset query parameter. offset/starting row .

  • limit (basestring, int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (basestring, int) – offset query parameter. offset/starting row .

  • limit (basestring, int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_compliance(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Run compliance check for device(s). .

Parameters:
  • categories (list) – Compliance’s categories (list of strings).

  • deviceUuids (list) – Compliance’s deviceUuids (list of strings).

  • triggerFull (boolean) – Compliance’s triggerFull.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_status_count(compliance_status=None, headers=None, **request_parameters)[source]

Return Compliance Status Count .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_detail(compliance_status=None, compliance_type=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return Compliance Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’ .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (basestring, int) – offset query parameter. offset/starting row .

  • limit (basestring, int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_compliance_detail_count(compliance_status=None, compliance_type=None, headers=None, **request_parameters)[source]

Return Compliance Count Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_compliance_status(device_uuid, headers=None, **request_parameters)[source]

Return compliance status of a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

compliance_details_of_device(device_uuid, category=None, compliance_type=None, diff_list=None, key=None, value=None, headers=None, **request_parameters)[source]

Return compliance detailed report for a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • category (basestring) – category query parameter. complianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ .

  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’ .

  • diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ] .

  • key (basestring) – key query parameter. extended attribute key .

  • value (basestring) – value query parameter. extended attribute value .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_archive

class ConfigurationArchive[source]

Cisco DNA Center Configuration Archive API (version: 2.3.3.0).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Export Device configurations to an encrypted zip file. .

Parameters:
  • deviceId (list) – Configuration Archive’s Device Id (list of strings).

  • password (string) – Configuration Archive’s Password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 2.3.3.0).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

clone_given_template(name, project_id, template_id, headers=None, **request_parameters)[source]

API to clone template .

Parameters:
  • name (basestring) – name path parameter. Template name to clone template(Name should be different than existing template name within same project) .

  • template_id (basestring) – templateId path parameter. UUID of the template to clone it .

  • project_id (basestring) – projectId path parameter.

  • project_id – projectId query parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to create a new project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (list) – Configuration Templates’s List of templates within the project (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to update an existing project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (list) – Configuration Templates’s List of templates within the project (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects(name=None, sort_order=None, headers=None, **request_parameters)[source]

List the projects .

Parameters:
  • name (basestring) – name query parameter. Name of project to be searched .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

imports_the_projects_provided(do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Imports the Projects provided in the DTO .

Parameters:
  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload ((list, dict)) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_projects(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the projects for given projectNames. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

imports_the_templates_provided(project_name, do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Imports the templates provided in the DTO by project Name .

Parameters:
  • project_name (basestring) – projectName path parameter. Project name to create template under the project .

  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_project_details(project_id, headers=None, **request_parameters)[source]

Get the details of the given project by its id. .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to get project details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_the_project(project_id, headers=None, **request_parameters)[source]

Deletes the project by its id .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a template by project id. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • project_id (basestring) – projectId path parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, project_names=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)[source]

List the templates available .

Parameters:
  • project_id (basestring) – projectId query parameter. Filter template(s) based on project UUID .

  • software_type (basestring) – softwareType query parameter. Filter template(s) based software type .

  • software_version (basestring) – softwareVersion query parameter. Filter template(s) based softwareVersion .

  • product_family (basestring) – productFamily query parameter. Filter template(s) based on device family .

  • product_series (basestring) – productSeries query parameter. Filter template(s) based on device series .

  • product_type (basestring) – productType query parameter. Filter template(s) based on device type .

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

  • tags (basestring, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

  • project_names (basestring, list, set, tuple) – projectNames query parameter. Filter template(s) based on project names .

  • un_committed (bool) – unCommitted query parameter. Filter template(s) based on template commited or not .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_template(author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a template. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of objects).

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

API to retrieve the status of template deployment. .

Parameters:
  • deployment_id (basestring) – deploymentId path parameter. UUID of deployment to retrieve template deployment status .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_templates(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the templates for given templateIds. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_template(deviceId=None, params=None, resourceParams=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to preview a template. .

Parameters:
  • deviceId (string) – Configuration Templates’s UUID of device to get template preview .

  • params (object) – Configuration Templates’s Params to render preview .

  • resourceParams (list) – Configuration Templates’s Resource params to render preview (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to get template preview .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to version the current contents of the template. .

Parameters:
  • comments (string) – Configuration Templates’s Template version comments .

  • templateId (string) – Configuration Templates’s UUID of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_versions(template_id, headers=None, **request_parameters)[source]

Get all the versions of template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) to get list of versioned templates .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_the_template(template_id, headers=None, **request_parameters)[source]

Deletes the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) of template to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Details of the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. TemplateId(UUID) to get details of the template .

  • latest_version (bool) – latestVersion query parameter. latestVersion flag to get the latest versioned template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_projects_details(id=None, limit=None, name=None, offset=None, sort_order=None, headers=None, **request_parameters)[source]

Get project(s) details .

Parameters:
  • id (basestring) – id query parameter. Id of project to be searched .

  • name (basestring) – name query parameter. Name of project to be searched .

  • offset (basestring, int) – offset query parameter. Index of first result .

  • limit (basestring, int) – limit query parameter. Limits number of results .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_templates_details(all_template_attributes=None, filter_conflicting_templates=None, id=None, include_version_details=None, limit=None, name=None, offset=None, product_family=None, product_series=None, product_type=None, project_id=None, project_name=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)[source]

Get template(s) details .

Parameters:
  • id (basestring) – id query parameter. Id of template to be searched .

  • name (basestring) – name query parameter. Name of template to be searched .

  • project_id (basestring) – projectId query parameter. Filter template(s) based on project id .

  • project_name (basestring) – projectName query parameter. Filter template(s) based on project name .

  • software_type (basestring) – softwareType query parameter. Filter template(s) based software type .

  • software_version (basestring) – softwareVersion query parameter. Filter template(s) based softwareVersion .

  • product_family (basestring) – productFamily query parameter. Filter template(s) based on device family .

  • product_series (basestring) – productSeries query parameter. Filter template(s) based on device series .

  • product_type (basestring) – productType query parameter. Filter template(s) based on device type .

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

  • tags (basestring, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

  • un_committed (bool) – unCommitted query parameter. Return uncommitted template .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

  • all_template_attributes (bool) – allTemplateAttributes query parameter. Return all template attributes .

  • include_version_details (bool) – includeVersionDetails query parameter. Include template version details .

  • offset (basestring, int) – offset query parameter. Index of first result .

  • limit (basestring, int) – limit query parameter. Limits number of results .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_template_v2(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

V2 API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (list) – Configuration Templates’s memberTemplateDeploymentInfo (list of objects).

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 2.3.3.0).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database. .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(cm_state=None, hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (basestring, int) – limit query parameter. Limits number of results .

  • offset (basestring, int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • mac_address (basestring) – macAddress query parameter. Device Mac Address .

  • hostname (basestring) – hostname query parameter. Device Hostname .

  • site_name (basestring) – siteName query parameter. Device Site Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow .

Parameters:
  • configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

  • fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

  • populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination .

Parameters:
  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Device Serial Number .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state .

Parameters:
  • deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • name (basestring) – name path parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

claim_a_device_to_a_site(configInfo=None, deviceId=None, gateway=None, imageInfo=None, ipInterfaceName=None, rfProfile=None, siteId=None, staticIP=None, subnetMask=None, type=None, vlanID=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms. .

Parameters:
  • configInfo (object) – Device Onboarding (PnP)’s configInfo.

  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • gateway (string) – Device Onboarding (PnP)’s gateway.

  • imageInfo (object) – Device Onboarding (PnP)’s imageInfo.

  • ipInterfaceName (string) – Device Onboarding (PnP)’s ipInterfaceName.

  • rfProfile (string) – Device Onboarding (PnP)’s rfProfile.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • staticIP (string) – Device Onboarding (PnP)’s staticIP.

  • subnetMask (string) – Device Onboarding (PnP)’s subnetMask.

  • type (string) – Device Onboarding (PnP)’s type.

  • vlanID (string) – Device Onboarding (PnP)’s vlanID.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration .

Parameters:
  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow .

Parameters:
  • deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • aaaCredentials (object) – Device Onboarding (PnP)’s aaaCredentials.

  • acceptEula (boolean) – Device Onboarding (PnP)’s acceptEula.

  • defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

  • savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Device Onboarding (PnP)’s taskTimeOuts.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information .

Parameters:
  • domain (basestring) – domain query parameter. Smart Account Domain .

  • name (basestring) – name query parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (basestring, int) – limit query parameter. Limits number of results .

  • offset (basestring, int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • type (basestring, list, set, tuple) – type query parameter. Workflow Type .

  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count .

Parameters:
  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_replacement

class DeviceReplacement[source]

Cisco DNA Center Device Replacement API (version: 2.3.3.0).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)[source]

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family. .

Parameters:
  • faulty_device_name (basestring) – faultyDeviceName query parameter. Faulty Device Name .

  • faulty_device_platform (basestring) – faultyDevicePlatform query parameter. Faulty Device Platform .

  • replacement_device_platform (basestring) – replacementDevicePlatform query parameter. Replacement Device Platform .

  • faulty_device_serial_number (basestring) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number .

  • replacement_device_serial_number (basestring) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number .

  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED] .

  • family (basestring, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP] .

  • sort_by (basestring) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. .

  • sort_order (basestring) – sortOrder query parameter. Order on displayName[ASC,DESC] .

  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

UnMarks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Marks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)[source]

Get replacement devices count .

Parameters:
  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images .

Parameters:
  • faultyDeviceSerialNumber (string) – Device Replacement’s faultyDeviceSerialNumber.

  • replacementDeviceSerialNumber (string) – Device Replacement’s replacementDeviceSerialNumber.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices

class Devices[source]

Cisco DNA Center Devices API (version: 2.3.3.0).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_planned_access_points_for_building(building_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)[source]

Provides a list of Planned Access Points for the Building it is requested for .

Parameters:
  • building_id (basestring) – buildingId path parameter. Building Id .

  • limit (basestring, int) – limit query parameter.

  • offset (basestring, int) – offset query parameter.

  • radios (bool) – radios query parameter. inlcude planned radio details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the device data is required .

  • search_by (basestring) – searchBy query parameter. MAC Address or Device Name value or UUID of the network device .

  • identifier (basestring) – identifier query parameter. One of keywords : macAddress or uuid or nwDeviceName .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. .

Parameters:
  • device_role (basestring) – deviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP) .

  • site_id (basestring) – siteId query parameter. Assurance site UUID value .

  • health (basestring) – health query parameter. The device overall health (One of POOR, FAIR, GOOD) .

  • start_time (int) – startTime query parameter. UTC epoch time in milliseconds .

  • end_time (int) – endTime query parameter. UTC epoch time in miliseconds .

  • limit (basestring, int) – limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) .

  • offset (basestring, int) – offset query parameter. The offset of the first device in the returned data .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_planned_access_points_for_floor(floor_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)[source]

Provides a list of Planned Access Points for the Floor it is requested for .

Parameters:
  • floor_id (basestring) – floorId path parameter. Floor Id .

  • limit (basestring, int) – limit query parameter.

  • offset (basestring, int) – offset query parameter.

  • radios (bool) – radios query parameter. inlcude planned radio details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_interfaces(limit=None, offset=None, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces .

Parameters:
  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces for specified device management IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. IP address of the interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • name (basestring) – name query parameter. Interface name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID .

Parameters:
  • id (basestring) – id path parameter. Interface ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_interface_details(interface_uuid, adminStatus=None, deployment_mode=None, description=None, vlanId=None, voiceVlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add/Update Interface description, VLAN membership, Voice VLAN and change Interface admin status (‘UP’/’DOWN’) from Request body. .

Parameters:
  • adminStatus (string) – Devices’s Admin Status.

  • description (string) – Devices’s Description.

  • vlanId (integer) – Devices’s Vlan Id.

  • voiceVlanId (integer) – Devices’s Voice Vlan Id.

  • interface_uuid (basestring) – interfaceUuid path parameter. Interface ID .

  • deployment_mode (basestring) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

legit_operations_for_interface(interface_uuid, headers=None, **request_parameters)[source]

Get list of all properties & operations valid for an interface. .

Parameters:
  • interface_uuid (basestring) – interfaceUuid path parameter. Interface ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

clear_mac_address_table(interface_uuid, deployment_mode=None, operation=None, payload=None, headers=None, active_validation=True, **request_parameters)[source]

Clear mac-address on an individual port. In request body, operation needs to be specified as ‘ClearMacAddress’. In the future more possible operations will be added to this API .

Parameters:
  • operation (string) – Devices’s Operation.

  • payload (dict) – Devices’s Payload.

  • interface_uuid (basestring) – interfaceUuid path parameter. Interface Id .

  • deployment_mode (basestring) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, device_support_level=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, limit=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, offset=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..* If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. You can also specify offset & limit to get the required list. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. .

  • device_support_level (basestring) – deviceSupportLevel query parameter.

  • offset (basestring, int) – offset query parameter. offset >= 1 [X gives results from Xth device onwards] .

  • limit (basestring, int) – limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_values_that_match_fully_or_partially_an_attribute(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Returns the list of values of the first given required parameter. You can use the .* in any value to conduct a wildcard search. For example, to get all the devices with the management IP address starting with 10.10. , issue the following request: GET /dna/inten/api/v1/network- device/autocomplete?managementIpAddress=10.10..* It will return the device management IP addresses that match fully or partially the provided attribute. {[10.10.1.1, 10.10.20.2, …]}. .

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router .

Parameters:
  • id (string) – Devices’s id.

  • role (string) – Devices’s role.

  • roleSource (string) – Devices’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file .

Parameters:
  • deviceUuids (list) – Devices’s deviceUuids (list of strings).

  • id (string) – Devices’s id.

  • operationEnum (string) – Devices’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – Devices’s parameters (list of strings).

  • password (string) – Devices’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices .

Parameters:
  • device_id (basestring) – deviceId query parameter. Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list. .

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id .

Parameters:
  • id (basestring) – id path parameter. Functional Capability UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Find all devices with link mismatch (speed / vlan) .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (basestring, int) – offset query parameter. Row Number. Default value is 1 .

  • limit (basestring, int) – limit query parameter. Default value is 500 .

  • category (basestring) – category query parameter. Links mismatch category. Value can be speed-duplex or vlan. .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter. Order. Value can be asc or desc. Default value is asc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_with_snmpv3_des(site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns devices added to Cisco DNA center with snmp v3 DES, where siteId is mandatory & accepts offset, limit, sortby, order which are optional. .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (basestring, int) – offset query parameter. Row Number. Default value is 1 .

  • limit (basestring, int) – limit query parameter. Default value is 500 .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. Device IP address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (basestring, int) – limit query parameter.

  • offset (basestring, int) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by ‘module id’ .

Parameters:
  • id (basestring) – id path parameter. Module id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device with given serial number .

Parameters:
  • serial_number (basestring) – serialNumber path parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device .

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

register_device_for_wsa(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

Registers a device for WSA notification .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Serial number of the device .

  • macaddress (basestring) – macaddress query parameter. Mac addres of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_chassis_details_for_device(device_id, headers=None, **request_parameters)[source]

Returns chassis details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_stack_details_for_device(device_id, headers=None, **request_parameters)[source]

Retrieves complete stack details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

return_power_supply_fan_details_for_the_given_device(device_uuid, type, headers=None, **request_parameters)[source]

Return PowerSupply/ Fan details for the Given device .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • type (basestring) – type query parameter. Type value should be PowerSupply or Fan .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_interface_details(device_uuid, interface_name_list=None, headers=None, **request_parameters)[source]

Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names which is optional and returns information for that particular interfaces where(operStatus = operationalStatus) .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • interface_name_list (basestring) – interfaceNameList query parameter. comma seperated interface names .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_connected_device_detail(device_uuid, interface_uuid, headers=None, **request_parameters)[source]

Get connected device detail for given deviceUuid and interfaceUuid .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of Device .

  • interface_uuid (basestring) – interfaceUuid path parameter. instanceuuid of interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_linecard_details(device_uuid, headers=None, **request_parameters)[source]

Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details_(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

poe_details(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_supervisor_card_detail(device_uuid, headers=None, **request_parameters)[source]

Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_by_id(id, clean_config=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • clean_config (bool) – cleanConfig query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs .

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – interfaceType query parameter. Vlan assocaited with sub-interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID .

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 2.3.3.0).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery .

Parameters:
  • attributeInfo (object) – Discovery’s attributeInfo.

  • cdpLevel (integer) – Discovery’s cdpLevel.

  • deviceIds (string) – Discovery’s deviceIds.

  • discoveryCondition (string) – Discovery’s discoveryCondition.

  • discoveryStatus (string) – Discovery’s discoveryStatus.

  • discoveryType (string) – Discovery’s discoveryType.

  • enablePasswordList (string) – Discovery’s enablePasswordList.

  • globalCredentialIdList (list) – Discovery’s globalCredentialIdList (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • id (string) – Discovery’s id.

  • ipAddressList (string) – Discovery’s ipAddressList.

  • ipFilterList (string) – Discovery’s ipFilterList.

  • isAutoCdp (boolean) – Discovery’s isAutoCdp.

  • lldpLevel (integer) – Discovery’s lldpLevel.

  • name (string) – Discovery’s name.

  • netconfPort (string) – Discovery’s netconfPort.

  • numDevices (integer) – Discovery’s numDevices.

  • parentDiscoveryId (string) – Discovery’s parentDiscoveryId.

  • passwordList (string) – Discovery’s passwordList.

  • preferredMgmtIPMethod (string) – Discovery’s preferredMgmtIPMethod.

  • protocolOrder (string) – Discovery’s protocolOrder.

  • retryCount (integer) – Discovery’s retryCount.

  • snmpAuthPassphrase (string) – Discovery’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Discovery’s snmpAuthProtocol.

  • snmpMode (string) – Discovery’s snmpMode.

  • snmpPrivPassphrase (string) – Discovery’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Discovery’s snmpPrivProtocol.

  • snmpRoCommunity (string) – Discovery’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – Discovery’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – Discovery’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – Discovery’s snmpRwCommunityDesc.

  • snmpUserName (string) – Discovery’s snmpUserName.

  • timeOut (integer) – Discovery’s timeOut.

  • updateMgmtIp (boolean) – Discovery’s updateMgmtIp.

  • userNameList (string) – Discovery’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters .

Parameters:
  • cdpLevel (integer) – Discovery’s CDP level to which neighbor devices to be discovered .

  • discoveryType (string) – Discovery’s Type of Discovery. ‘SINGLE’, ‘RANGE’, ‘MULTI RANGE’, ‘CDP’, ‘LLDP’ .

  • enablePasswordList (list) – Discovery’s Enable Password of the devices to be discovered (list of strings).

  • globalCredentialIdList (list) – Discovery’s Global Credential Ids to be used for discovery (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • ipAddressList (string) – Discovery’s IP Address of devices to be discovered. Ex: ‘172.30.0.1’ for SINGLE, CDP and LLDP; ‘72.30.0.1-172.30.0.4’ for RANGE; ‘72.30.0.1-172.30.0.4,172.31.0.1-172.31.0.4’ for MULTI RANGE .

  • ipFilterList (list) – Discovery’s IP Addresses of the devices to be filtered out during discovery (list of strings).

  • lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

  • name (string) – Discovery’s Name of the discovery .

  • netconfPort (string) – Discovery’s Netconf Port. It will need valid SSH credentials to work .

  • passwordList (list) – Discovery’s Password of the devices to be discovered (list of strings).

  • preferredMgmtIPMethod (string) – Discovery’s Preferred Management IP Method.’None’ or ‘UseLoopBack’. Default is ‘None’ .

  • protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

  • retry (integer) – Discovery’s Number of times to try establishing connection to device .

  • snmpAuthPassphrase (string) – Discovery’s Auth Pass phrase for SNMP .

  • snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

  • snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

  • snmpPrivPassphrase (string) – Discovery’s Pass phrase for SNMP privacy .

  • snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘DES’ or ‘AES128’ .

  • snmpROCommunity (string) – Discovery’s Snmp RO community of the devices to be discovered .

  • snmpROCommunityDesc (string) – Discovery’s Description for Snmp RO community .

  • snmpRWCommunity (string) – Discovery’s Snmp RW community of the devices to be discovered .

  • snmpRWCommunityDesc (string) – Discovery’s Description for Snmp RW community .

  • snmpUserName (string) – Discovery’s SNMP username of the device .

  • snmpVersion (string) – Discovery’s Version of SNMP. v2 or v3 .

  • timeout (integer) – Discovery’s Time to wait for device response in seconds .

  • userNameList (list) – Discovery’s Username of the devices to be discovered (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP .

Parameters:
  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network_devices_from_discovery(id, cli_status=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • cli_status (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_delete (int) – recordsToDelete path parameter. Number of records to delete .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type .

Parameters:
  • credential_sub_type (basestring) – credentialSubType query parameter. Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF .

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • enablePassword (string) – Discovery’s enablePassword.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • netconfPort (string) – Discovery’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_read_community(comments=None, credentialType=None, description=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community .

Parameters:
  • comments (string) – Discovery’s Comments to identify the credential .

  • credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s Name/Description of the credential .

  • instanceUuid (string) – Discovery’s instanceUuid.

  • readCommunity (string) – Discovery’s SNMP read community. NO!$DATA!$ for no value change .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmp_write_community(comments=None, credentialType=None, description=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community .

Parameters:
  • comments (string) – Discovery’s Comments to identify the credential .

  • credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s Name/Description of the credential .

  • instanceUuid (string) – Discovery’s instanceUuid.

  • writeCommunity (string) – Discovery’s SNMP write community. NO!$DATA!$ for no value change .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential .

Parameters:
  • authPassword (string) – Discovery’s authPassword.

  • authType (string) – Discovery’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • privacyPassword (string) – Discovery’s privacyPassword.

  • privacyType (string) – Discovery’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – Discovery’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID .

Parameters:
  • global_credential_id (basestring) – globalCredentialId path parameter. ID of global-credential .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s) .

Parameters:
  • siteUuids (list) – Discovery’s siteUuids (list of strings).

  • global_credential_id (basestring) – globalCredentialId path parameter. Global credential Uuid .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id .

Parameters:
  • id (basestring) – id path parameter. Global Credential ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 2.3.3.0).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

get_auditlog_parent_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Parent Audit Log Event instances from the Event-Hub .

Parameters:
  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (basestring, int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (basestring, int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_summary(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_parent_only=None, is_system_events=None, name=None, parent_instance_id=None, severity=None, site_id=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Summary from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • is_parent_only (bool) – isParentOnly query parameter. Parameter to filter parent only audit-logs. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_auditlog_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, parent_instance_id=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Event instances from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (basestring, int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (basestring, int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter .

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_email_destination(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Email Destination .

Parameters:
  • emailConfigId (string) – Event Management’s Required only for update email configuration .

  • fromEmail (string) – Event Management’s From Email.

  • primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

  • secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

  • subject (string) – Event Management’s Subject.

  • toEmail (string) – Event Management’s To Email.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_email_destination(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Email Destination .

Parameters:
  • emailConfigId (string) – Event Management’s Required only for update email configuration .

  • fromEmail (string) – Event Management’s From Email.

  • primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

  • secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

  • subject (string) – Event Management’s Subject.

  • toEmail (string) – Event Management’s To Email.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=None, namespace=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, tags=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • offset (basestring, int) – offset query parameter. Start Offset .

  • limit (basestring, int) – limit query parameter. # of records .

  • sort_by (basestring) – sortBy query parameter. Sort By column .

  • order (basestring) – order query parameter. Ascending/Descending order [asc/desc] .

  • tags (basestring) – tags query parameter.

  • namespace (basestring) – namespace query parameter.

  • site_id (basestring) – siteId query parameter. Site Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit (Deprecated) .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • offset (basestring, int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions .

Parameters:
  • subscriptions (basestring) – subscriptions query parameter. List of EventSubscriptionId’s for removal .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events(Deprecated) .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events (Deprecated) .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • offset (basestring, int) – offset query parameter. The number of Email Subscription detail’s to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Email Subscription detail’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • offset (basestring, int) – offset query parameter. The number of Rest/Webhook Subscription detail’s to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Rest/Webhook Subscription detail’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • offset (basestring, int) – offset query parameter. The number of Syslog Subscription detail’s to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Syslog Subscription detail’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Email Subscription Endpoint for list of registered events. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Email Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_email_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Gets the list of email Subscriptions’s based on provided query params .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (basestring, int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • domain (basestring) – domain query parameter. List of email subscriptions related to the respective domain .

  • sub_domain (basestring) – subDomain query parameter. List of email subscriptions related to the respective sub-domain .

  • category (basestring) – category query parameter. List of email subscriptions related to the respective category .

  • type (basestring) – type query parameter. List of email subscriptions related to the respective type .

  • name (basestring) – name query parameter. List of email subscriptions related to the respective name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_rest_webhook_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Gets the list of Rest/Webhook Subscriptions’s based on provided query params .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (basestring, int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • domain (basestring) – domain query parameter. List of subscriptions related to the respective domain .

  • sub_domain (basestring) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

  • category (basestring) – category query parameter. List of subscriptions related to the respective category .

  • type (basestring) – type query parameter. List of subscriptions related to the respective type .

  • name (basestring) – name query parameter. List of subscriptions related to the respective name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_syslog_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Gets the list of Syslog Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (basestring, int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • domain (basestring) – domain query parameter. List of subscriptions related to the respective domain .

  • sub_domain (basestring) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

  • category (basestring) – category query parameter. List of subscriptions related to the respective category .

  • type (basestring) – type query parameter. List of subscriptions related to the respective type .

  • name (basestring) – name query parameter. List of subscriptions related to the respective name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_syslog_destination(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Syslog Destination .

Parameters:
  • configId (string) – Event Management’s Required only for update syslog configuration .

  • description (string) – Event Management’s Description.

  • host (string) – Event Management’s Host.

  • name (string) – Event Management’s Name.

  • port (string) – Event Management’s Port.

  • protocol (string) – Event Management’s Protocol. Available values are ‘UDP’ and ‘TCP’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_syslog_destination(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Syslog Destination .

Parameters:
  • configId (string) – Event Management’s Required only for update syslog configuration .

  • description (string) – Event Management’s Description.

  • host (string) – Event Management’s Host.

  • name (string) – Event Management’s Name.

  • port (string) – Event Management’s Port.

  • protocol (string) – Event Management’s Protocol. Available values are ‘UDP’ and ‘TCP’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_webhook_destination(description=None, headers=None, method=None, name=None, trustCert=None, url=None, webhookId=None, payload=None, active_validation=True, **request_parameters)[source]

Create Webhook Destination .

Parameters:
  • description (string) – Event Management’s Description.

  • headers (dict) – Event Management’s headers (list of objects).

  • method (string) – Event Management’s Method. Available values are ‘POST’ and ‘PUT’.

  • name (string) – Event Management’s Name.

  • trustCert (boolean) – Event Management’s Trust Cert.

  • url (string) – Event Management’s Url.

  • webhookId (string) – Event Management’s Required only for update webhook configuration .

  • headers – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_webhook_destination(description=None, headers=None, method=None, name=None, trustCert=None, url=None, webhookId=None, payload=None, active_validation=True, **request_parameters)[source]

Update Webhook Destination .

Parameters:
  • description (string) – Event Management’s Description.

  • headers (dict) – Event Management’s headers (list of objects).

  • method (string) – Event Management’s Method. Available values are ‘POST’ and ‘PUT’.

  • name (string) – Event Management’s Name.

  • trustCert (boolean) – Event Management’s Trust Cert.

  • url (string) – Event Management’s Url.

  • webhookId (string) – Event Management’s Required only for update webhook configuration .

  • headers – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_events(tags, event_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • offset (basestring, int) – offset query parameter. The number of Registries to offset in the resultset whose default value 0 .

  • limit (basestring, int) – limit query parameter. The number of Registries to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_eventartifacts(event_ids=None, limit=None, offset=None, order=None, search=None, sort_by=None, tags=None, headers=None, **request_parameters)[source]

Gets the list of artifacts based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of eventIds .

  • tags (basestring) – tags query parameter. Tags defined .

  • offset (basestring, int) – offset query parameter. Record start offset .

  • limit (basestring, int) – limit query parameter. # of records to return in result set .

  • sort_by (basestring) – sortBy query parameter. Sort by field .

  • order (basestring) – order query parameter. sorting order (asc/desc) .

  • search (basestring) – search query parameter. findd matches in name, description, eventId, type, category .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

eventartifact_count(headers=None, **request_parameters)[source]

Get the count of registered event artifacts with provided eventIds or tags as mandatory .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_connector_types(headers=None, **request_parameters)[source]

Get the list of connector types .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

fabric_wireless

class FabricWireless[source]

Cisco DNA Center Fabric Wireless API (version: 2.3.3.0).

Wraps the DNA Center Fabric Wireless API and exposes the API as native Python methods that return native Python objects.

add_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SSID to IP Pool Mapping. .

Parameters:
  • scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

  • vlanName (string) – Fabric Wireless’s VLAN Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_ssid_to_ip_pool_mapping2(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SSID to IP Pool Mapping. .

Parameters:
  • scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

  • vlanName (string) – Fabric Wireless’s VLAN Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]
get_ssid_to_ip_pool_mapping(site_name_hierarchy, vlan_name, headers=None, **request_parameters)[source]

Get SSID to IP Pool Mapping .

Parameters:
  • vlan_name (basestring) – vlanName query parameter. VLAN Name .

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Heirarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_w_l_c_from_fabric_domain(device_ipaddress, headers=None, **request_parameters)[source]

Remove WLC from Fabric Domain .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device Management IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_w_l_c_to_fabric_domain(deviceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add WLC to Fabric Domain .

Parameters:
  • deviceName (string) – Fabric Wireless’s EWLC Device Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

file

class File[source]

Cisco DNA Center File API (version: 2.3.3.0).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace .

Parameters:
  • name_space (basestring) – nameSpace path parameter. A listing of fileId’s .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId .

Parameters:
  • file_id (basestring) – fileId path parameter. File Identification number .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

upload_file(multipart_fields, multipart_monitor_callback, name_space, headers=None, **request_parameters)[source]

Uploads a new file within a specific nameSpace .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • name_space (basestring) – nameSpace path parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

health_and_performance

class HealthAndPerformance[source]

Cisco DNA Center Health and Performance API (version: 2.3.3.0).

Wraps the DNA Center Health and Performance API and exposes the API as native Python methods that return native Python objects.

system_health(domain=None, limit=None, offset=None, subdomain=None, summary=None, headers=None, **request_parameters)[source]

This API retrieves the latest system events .

Parameters:
  • summary (bool) – summary query parameter. Fetch the latest high severity event .

  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • limit (basestring, int) – limit query parameter.

  • offset (basestring, int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_health_count(domain=None, subdomain=None, headers=None, **request_parameters)[source]

This API gives the count of the latest system events .

Parameters:
  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_performance(end_time=None, function=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API gives the aggregated performance indicators. The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Valid values: cpu,memory,network .

  • function (basestring) – function query parameter. Valid values: sum,average,max .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_performance_historical(end_time=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API retrieves the historical performance indicators . The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Fetch historical data for this kpi. Valid values: cpu,memory,network .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

itsm

class Itsm[source]

Cisco DNA Center ITSM API (version: 2.3.3.0).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_cmdb_sync_status(date=None, status=None, headers=None, **request_parameters)[source]

This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter “status”,”date”.The supported values for status field are “Success”,”Failed”,”Unknown” and date field should be in “YYYY-MM- DD” format. By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response. .

Parameters:
  • status (basestring) – status query parameter. Supported values are “Success”,”Failed” and “Unknown”. Providing other values will result in all the available sync job status. .

  • date (basestring) – date query parameter. Provide date in “YYYY-MM-DD” format .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)[source]

Used to retrieve the list of integration events that failed to create tickets in ITSM .

Parameters:
  • instance_id (basestring) – instanceId query parameter. Instance Id of the failed event as in the Runtime Dashboard .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues

class Issues[source]

Cisco DNA Center Issues API (version: 2.3.3.0).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

issues(ai_driven=None, device_id=None, end_time=None, issue_status=None, mac_address=None, priority=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device’s MAC address. .

Parameters:
  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of query time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of query time window .

  • site_id (basestring) – siteId query parameter. Assurance UUID value of the site in the issue content .

  • device_id (basestring) – deviceId query parameter. Assurance UUID value of the device in the issue content .

  • mac_address (basestring) – macAddress query parameter. Client’s device MAC address of the issue (format xx:xx:xx:xx:xx:xx) .

  • priority (basestring) – priority query parameter. The issue’s priority value (One of P1, P2, P3, or P4)(Use only when macAddress and deviceId are not provided) .

  • ai_driven (basestring) – aiDriven query parameter. The issue’s AI driven value (Yes or No)(Use only when macAddress and deviceId are not provided) .

  • issue_status (basestring) – issueStatus query parameter. The issue’s status value (One of ACTIVE, IGNORED, RESOLVED) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

lan_automation

class LanAutomation[source]

Cisco DNA Center LAN Automation API (version: 2.3.3.0).

Wraps the DNA Center LAN Automation API and exposes the API as native Python methods that return native Python objects.

lan_automation(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Invoke this API to start LAN Automation for the given site. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

lan_automation_session_count(headers=None, **request_parameters)[source]

Invoke this API to get the total count of LAN Automation sessions. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

lan_automation_log(limit=None, offset=None, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session logs. .

Parameters:
  • offset (basestring, int) – offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. .

  • limit (basestring, int) – limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

lan_automation_log_by_id(id, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session logs based on the given LAN Automation session id. .

Parameters:
  • id (basestring) – id path parameter. LAN Automation session identifier. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

lan_automation_status(limit=None, offset=None, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session status. .

Parameters:
  • offset (basestring, int) – offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. .

  • limit (basestring, int) – limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

lan_automation_status_by_id(id, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session status based on the given Lan Automation session id. .

Parameters:
  • id (basestring) – id path parameter. LAN Automation session identifier. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

lan_automation_stop(id, headers=None, **request_parameters)[source]

Invoke this API to stop LAN Automation for the given site. .

Parameters:
  • id (basestring) – id path parameter. LAN Automation id can be obtained from /dna/intent/api/v1/lan- automation/status. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

licenses

class Licenses[source]

Cisco DNA Center Licenses API (version: 2.3.3.0).

Wraps the DNA Center Licenses API and exposes the API as native Python methods that return native Python objects.

device_count_details(device_type=None, dna_level=None, registration_status=None, smart_account_id=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Get total number of managed device(s). .

Parameters:
  • device_type (basestring) – device_type query parameter. Type of device .

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA license level .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Name of virtual account .

  • smart_account_id (basestring) – smart_account_id query parameter. Id of smart account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_license_summary(limit, order, page_number, device_type=None, device_uuid=None, dna_level=None, registration_status=None, smart_account_id=None, sort_by=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Show license summary of device(s). .

Parameters:
  • page_number (int) – page_number query parameter. Page number of response .

  • order (basestring) – order query parameter. Sorting order .

  • sort_by (basestring) – sort_by query parameter. Sort result by field .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA license level .

  • device_type (basestring) – device_type query parameter. Type of device .

  • limit (basestring, int) – limit query parameter.

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Name of virtual account .

  • smart_account_id (int) – smart_account_id query parameter. Id of smart account .

  • device_uuid (basestring) – device_uuid query parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_license_details(device_uuid, headers=None, **request_parameters)[source]

Get detailed license information of a device. .

Parameters:
  • device_uuid (basestring) – device_uuid path parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_deregistration(device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deregister device(s) from CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

device_registration(virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Register device(s) in CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

change_virtual_account(smart_account_id, virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Transfer device(s) from one virtual account to another within same smart account. .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of target virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

virtual_account_details(smart_account_id, headers=None, **request_parameters)[source]

Get virtual account details of a smart account. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

smart_account_details(headers=None, **request_parameters)[source]

Get detail of all smart accounts. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

license_term_details(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get license term details. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license term detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

license_usage_details(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get count of purchased and in use Cisco DNA and Network licenses. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license usage detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 2.3.3.0).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential To Site .

Parameters:
  • cliId (string) – Network Settings’s Cli Id.

  • httpRead (string) – Network Settings’s Http Read.

  • httpWrite (string) – Network Settings’s Http Write.

  • snmpV2ReadId (string) – Network Settings’s Snmp V2 Read Id.

  • snmpV2WriteId (string) – Network Settings’s Snmp V2 Write Id.

  • snmpV3Id (string) – Network Settings’s Snmp V3 Id.

  • site_id (basestring) – siteId path parameter. site id to assign credential. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve the credential details associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential. .

Parameters:
  • id (basestring) – id path parameter. global credential id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool. .

Parameters:
  • offset (basestring, int) – offset query parameter. offset/starting row .

  • limit (basestring, int) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool. .

Parameters:
  • id (basestring) – id path parameter. global pool id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to get the network settings associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpint AAA, and/or DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to which site details to associate with the network settings. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network for DHCP and DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to update the network settings which is associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_reserve_ip_subpool(limit=None, offset=None, site_id=None, headers=None, **request_parameters)[source]

API to get the ip subpool info. .

Parameters:
  • site_id (basestring) – siteId query parameter. site id to get the reserve ip associated with the site .

  • offset (basestring, int) – offset query parameter. offset/starting row .

  • limit (basestring, int) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

release_reserve_ip_subpool(id, headers=None, **request_parameters)[source]

API to delete the reserved ip subpool .

Parameters:
  • id (basestring) – id path parameter. Id of reserve ip subpool to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reserve_ip_subpool(site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv4GlobalPool=None, ipv4Prefix=None, ipv4PrefixLength=None, ipv4Subnet=None, ipv4TotalHost=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to reserve an ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv4GateWay (string) – Network Settings’s Gateway ip address details, example: 175.175.0.1 .

  • ipv4GlobalPool (string) – Network Settings’s IP v4 Global pool address with cidr, example: 175.175.0.0/16 .

  • ipv4Prefix (boolean) – Network Settings’s IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable .

  • ipv4PrefixLength (integer) – Network Settings’s The ipv4 prefix length is required when ipv4prefix value is true. .

  • ipv4Subnet (string) – Network Settings’s IPv4 Subnet address, example: 175.175.0.0 .

  • ipv4TotalHost (integer) – Network Settings’s IPv4 total host is required when ipv4prefix value is false. .

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • type (string) – Network Settings’s Type of the reserve ip sub pool . Available values are ‘Generic’, ‘LAN’, ‘WAN’, ‘management’ and ‘service’.

  • site_id (basestring) – siteId path parameter. Site id to reserve the ip sub pool. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_reserve_ip_subpool(id, site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv4GateWay (string) – Network Settings’s Ipv4 Gate Way.

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IP v6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s IPv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • site_id (basestring) – siteId path parameter. Site id of site to update sub pool. .

  • id (basestring) – id query parameter. Id of subpool to be associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS). .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create service provider profile(QOS). .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update SP profile .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider profile (QoS). .

Parameters:
  • sp_profile_name (basestring) – spProfileName path parameter. sp profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 2.3.3.0).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters. .

Parameters:
  • periodic_refresh (bool) – periodicRefresh query parameter. Is analysis periodically refreshed? .

  • source_ip (basestring) – sourceIP query parameter. Source IP address .

  • dest_ip (basestring) – destIP query parameter. Destination IP adress .

  • source_port (basestring) – sourcePort query parameter. Source port .

  • dest_port (basestring) – destPort query parameter. Destination port .

  • gt_create_time (basestring) – gtCreateTime query parameter. Analyses requested after this time .

  • lt_create_time (basestring) – ltCreateTime query parameter. Analyses requested before this time .

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – taskId query parameter. Task ID .

  • last_update_time (basestring) – lastUpdateTime query parameter. Last update time .

  • limit (basestring, int) – limit query parameter. Number of resources returned .

  • offset (basestring, int) – offset query parameter. Start index of resources returned (1-based) .

  • order (basestring) – order query parameter. Order by this field .

  • sort_by (basestring) – sortBy query parameter. Sort by this field .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress. .

Parameters:
  • controlPath (boolean) – Path Trace’s controlPath.

  • destIP (string) – Path Trace’s destIP.

  • destPort (string) – Path Trace’s destPort.

  • inclusions (list) – Path Trace’s inclusions (list of strings).

  • periodicRefresh (boolean) – Path Trace’s periodicRefresh.

  • protocol (string) – Path Trace’s protocol.

  • sourceIP (string) – Path Trace’s sourceIP.

  • sourcePort (string) – Path Trace’s sourcePort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

platform_configuration

class PlatformConfiguration[source]

Cisco DNA Center Platform Configuration API (version: 2.3.3.0).

Wraps the DNA Center Platform Configuration API and exposes the API as native Python methods that return native Python objects.

release_summary(headers=None, **request_parameters)[source]

Provides information such as API version, mandatory core packages for installation or upgrade, optional packages, Cisco DNA Center name and version, supported direct updates, and tenant ID. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nodes_configuration_summary(headers=None, **request_parameters)[source]

Provides details about the current Cisco DNA Center node configuration, such as API version, node name, NTP server, intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default gateway, and interface information. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

reports

class Reports[source]

Cisco DNA Center Reports API (version: 2.3.3.0).

Wraps the DNA Center Reports API and exposes the API as native Python methods that return native Python objects.

create_or_schedule_a_report(deliveries=None, name=None, schedule=None, tags=None, view=None, viewGroupId=None, viewGroupVersion=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Schedule a report configuration. Use “Get view details for a given view group & view” API to get the metadata required to configure a report. .

Parameters:
  • deliveries (list) – Reports’s Array of available delivery channels (list of objects).

  • name (string) – Reports’s report name .

  • schedule (object) – Reports’s schedule.

  • tags (list) – Reports’s array of tags for report (list of strings).

  • view (object) – Reports’s view.

  • viewGroupId (string) – Reports’s viewGroupId of the viewgroup for the report .

  • viewGroupVersion (string) – Reports’s version of viewgroup for the report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_list_of_scheduled_reports(view_group_id=None, view_id=None, headers=None, **request_parameters)[source]

Get list of scheduled report configurations. .

Parameters:
  • view_group_id (basestring) – viewGroupId query parameter. viewGroupId of viewgroup for report .

  • view_id (basestring) – viewId query parameter. viewId of view for report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Get scheduled report configuration by reportId .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Delete a scheduled report configuration. Deletes the report executions also. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_all_execution_details_for_a_given_report(report_id, headers=None, **request_parameters)[source]

Get details of all executions for a given report .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

download_report_content(execution_id, report_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • execution_id (basestring) – executionId path parameter. executionId of report execution .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

get_all_view_groups(headers=None, **request_parameters)[source]

Gives a list of summary of all view groups. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_views_for_a_given_view_group(view_group_id, headers=None, **request_parameters)[source]

Gives a list of summary of all views in a viewgroup. Use “Get all view groups” API to get the viewGroupIds (required as a query param for this API) for available viewgroups. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_view_details_for_a_given_view_group_and_view(view_group_id, view_id, headers=None, **request_parameters)[source]

Gives complete information of the view that is required to configure a report. Use “Get views for a given view group” API to get the viewIds (required as a query param for this API) for available views. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup .

  • view_id (basestring) – viewId path parameter. view id of view .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sda

class Sda[source]

Cisco DNA Center SDA API (version: 2.3.3.0).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

get_default_authentication_profile(site_name_hierarchy, authenticate_template_name=None, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • authenticate_template_name (basestring) – authenticateTemplateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication template in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete default authentication profile in SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add border device in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

gets_border_device_detail(device_management_ip_address, headers=None, **request_parameters)[source]

Get border device detail from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

deletes_border_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete border device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_control_plane_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_control_plane_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_control_plane_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_info(device_management_ip_address, headers=None, **request_parameters)[source]

Get device info from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_role_in_sda_fabric(device_management_ip_address, headers=None, **request_parameters)[source]

Get device role in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Device Management IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_edge_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

  • siteNameHierarchy (string) – SDA’s siteNameHierarchy of the Provisioned Device(site should be part of Fabric Site) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_edge_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_edge_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_site(fabricName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric .

Parameters:
  • fabricName (string) – SDA’s Warning Starting DNA Center 2.2.3.5 release, this field has been deprecated. SD-Access Fabric does not need it anymore. It will be removed in future DNA Center releases. .

  • siteNameHierarchy (string) – SDA’s Existing site name hierarchy available at global level. For Example “Global/Chicago/Building21/Floor1” .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_access_point(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated to Fabric Site . Available values are ‘No Authentication’, ‘Open Authentication’, ‘Closed Authentication ‘ and ‘Low Impact’.

  • dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to INFRA_VN .

  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the edge device .

  • interfaceDescription (string) – SDA’s Details or note of interface port assignment .

  • interfaceName (string) – SDA’s Interface Name of the edge device .

  • siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_port_assignment_for_user_device(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, scalableGroupName=None, siteNameHierarchy=None, voiceIpAddressPoolName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric. .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated with siteNameHierarchy . Available values are ‘Open Authentication’, ‘Closed Authentication’, ‘Low Impact’, ‘No Authentication’ and ‘’.

  • dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as DATA(can’t be empty if voiceIpAddressPoolName is empty) .

  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the edge device .

  • interfaceDescription (string) – SDA’s User defined text message for this port .

  • interfaceName (string) – SDA’s Interface Name of the Edge Node .

  • scalableGroupName (string) – SDA’s Scalable Group name associated with VN .

  • siteNameHierarchy (string) – SDA’s Complete Path of SD-Access Fabric Site .

  • voiceIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as VOICE(can’t be empty if dataIpAddressPoolName is empty) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_multicast_in_sda_fabric(multicastMethod=None, multicastType=None, multicastVnInfo=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add multicast in SDA fabric .

Parameters:
  • multicastMethod (string) – SDA’s Multicast Method . Available values are ‘native_multicast’.

  • multicastType (string) – SDA’s Multicast Type . Available values are ‘ssm’, ‘asm_with_internal_rp’ and ‘asm_with_external_rp’.

  • multicastVnInfo (list) – SDA’s multicastVnInfo (list of objects).

  • siteNameHierarchy (string) – SDA’s Full path of sda Fabric Site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_multicast_details_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)[source]

Get multicast details from SDA fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. fabric site name hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_multicast_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete multicast from SDA fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Valid IP address of the device currently provisioned in a fabric site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

re_provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Re-Provision Wired Device .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be re-provisioned .

  • siteNameHierarchy (string) – SDA’s siteNameHierarchy of the provisioned device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision Wired Device .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be provisioned .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy for device location(only building / floor level) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get Provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_transit_peer_network(transit_peer_network_name, headers=None, **request_parameters)[source]

Delete Transit Peer Network from SD-Access .

Parameters:
  • transit_peer_network_name (basestring) – transitPeerNetworkName query parameter. Transit Peer Network Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_transit_peer_network_info(transit_peer_network_name, headers=None, **request_parameters)[source]

Get Transit Peer Network Info from SD-Access .

Parameters:
  • transit_peer_network_name (basestring) – transitPeerNetworkName query parameter. Transit or Peer Network Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_transit_peer_network(ipTransitSettings=None, sdaTransitSettings=None, transitPeerNetworkName=None, transitPeerNetworkType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Transit Peer Network in SD-Access .

Parameters:
  • ipTransitSettings (object) – SDA’s ipTransitSettings.

  • sdaTransitSettings (object) – SDA’s sdaTransitSettings.

  • transitPeerNetworkName (string) – SDA’s Transit Peer Network Name .

  • transitPeerNetworkType (string) – SDA’s Transit Peer Network Type . Available values are ‘ip_transit’, ‘sda_transit_with_lisp_bgp’ and ‘sda_transit_with_pub_sub’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_vn(siteNameHierarchy=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

  • virtualNetworkName (string) – SDA’s Virtual Network Name, that is created at Global level .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-vn

get_virtual_network_summary(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Virtual Network Summary .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Complete fabric siteNameHierarchy Path .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • ip_pool_name (basestring) – ipPoolName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • ip_pool_name (basestring) – ipPoolName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_ip_pool_in_sda_virtual_network(autoGenerateVlanName=None, ipPoolName=None, isCommonPool=None, isIpDirectedBroadcast=None, isL2FloodingEnabled=None, isLayer2Only=None, isThisCriticalPool=None, isWirelessPool=None, poolType=None, scalableGroupName=None, siteNameHierarchy=None, trafficType=None, virtualNetworkName=None, vlanId=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network .

Parameters:
  • autoGenerateVlanName (boolean) – SDA’s It will auto generate vlanName, if vlanName is empty(applicable for L3 and INFRA_VN) .

  • ipPoolName (string) – SDA’s Ip Pool Name, that is reserved to Fabric Site for (applicable for L3 and INFRA_VN) .

  • isCommonPool (boolean) – SDA’s Common Pool enablement flag(applicable for L3 and L2 and default value is False ) .

  • isIpDirectedBroadcast (boolean) – SDA’s Ip Directed Broadcast enablement flag(applicable for L3 and default value is False ) .

  • isL2FloodingEnabled (boolean) – SDA’s Layer2 flooding enablement flag(applicable for L3 , L2 and always true for L2 and default value is False ) .

  • isLayer2Only (boolean) – SDA’s Layer2 Only enablement flag and default value is False .

  • isThisCriticalPool (boolean) – SDA’s Critical pool enablement(applicable for L3 and default value is False ) .

  • isWirelessPool (boolean) – SDA’s Wireless Pool enablement flag(applicable for L3 and L2 and default value is False ) .

  • poolType (string) – SDA’s Pool Type (applicable for INFRA_VN) . Available values are ‘AP’ and ‘Extended’.

  • scalableGroupName (string) – SDA’s Scalable Group Name(applicable for L3) .

  • siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

  • trafficType (string) – SDA’s Traffic type(applicable for L3 and L2) . Available values are ‘Data’ and ‘Voice’.

  • virtualNetworkName (string) – SDA’s Virtual Network Name, that is associated to Fabric Site .

  • vlanId (string) – SDA’s vlan Id(applicable for L3 , L2 and INFRA_VN) .

  • vlanName (string) – SDA’s Vlan name represent the segment name, if empty, vlanName would be auto generated by API .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network with scalable groups at global level .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s To create guest virtual network .

  • scalableGroupNames (list) – SDA’s Scalable Group to be associated to virtual network (list of strings).

  • virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned at global level .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update virtual network with scalable groups .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s To create guest virtual network .

  • scalableGroupNames (list) – SDA’s Scalable Group Name to be associated to virtual network (list of strings).

  • virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned global level .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

security_advisories

class SecurityAdvisories[source]

Cisco DNA Center Security Advisories API (version: 2.3.3.0).

Wraps the DNA Center Security Advisories API and exposes the API as native Python methods that return native Python objects.

get_advisories_list(headers=None, **request_parameters)[source]

Retrieves list of advisories on the network .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_summary(headers=None, **request_parameters)[source]

Retrieves summary of advisories on the network. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_devices_per_advisory(advisory_id, headers=None, **request_parameters)[source]

Retrieves list of devices for an advisory .

Parameters:
  • advisory_id (basestring) – advisoryId path parameter. Advisory ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisory_ids_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisory IDs for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_advisories_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisories for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors

class Sensors[source]

Cisco DNA Center Sensors API (version: 2.3.3.0).

Wraps the DNA Center Sensors API and exposes the API as native Python methods that return native Python objects.

edit_sensor_test_template(locationInfoList=None, schedule=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to deploy, schedule, or edit and existing SENSOR test template .

Parameters:
  • locationInfoList (list) – Sensors’s locationInfoList (list of objects).

  • schedule (object) – Sensors’s schedule.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_sensor_test_template(apCoverage=None, connection=None, modelVersion=None, name=None, ssids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID .

Parameters:
  • apCoverage (list) – Sensors’s apCoverage (list of objects).

  • connection (string) – Sensors’s Connection.

  • modelVersion (integer) – Sensors’s Model Version.

  • name (string) – Sensors’s Name.

  • ssids (list) – Sensors’s ssids (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_sensor_test(template_name=None, headers=None, **request_parameters)[source]

Intent API to delete an existing SENSOR test template .

Parameters:
  • template_name (basestring) – templateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sensors(site_id=None, headers=None, **request_parameters)[source]

Intent API to get a list of SENSOR devices .

Parameters:
  • site_id (basestring) – siteId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

run_now_sensor_test(templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to run a deployed SENSOR test .

Parameters:
  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

duplicate_sensor_test_template(newTemplateName=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to duplicate an existing SENSOR test template .

Parameters:
  • newTemplateName (string) – Sensors’s New Template Name.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 2.3.3.0).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor . .

Parameters:
  • provisioning (list) – Site Design’s provisioning (list of objects).

  • siteProfile (list) – Site Design’s siteProfile (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address. .

Parameters:
  • device_ip (basestring) – deviceIp query parameter. Device to which the provisioning detail has to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

associate(network_profile_id, site_id, headers=None, **request_parameters)[source]

Associate Site to a Network Profile .

Parameters:
  • network_profile_id (basestring) – networkProfileId path parameter. Network-Profile Id to be associated .

  • site_id (basestring) – siteId path parameter. Site Id to be associated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

disassociate(network_profile_id, site_id, headers=None, **request_parameters)[source]

Disassociate a Site from a Network Profile .

Parameters:
  • network_profile_id (basestring) – networkProfileId path parameter. Network-Profile Id to be associated .

  • site_id (basestring) – siteId path parameter. Site Id to be associated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information. .

Parameters:
  • device_ip (string) – Site Design’s Device Ip.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network profile for different NFV topologies .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • profileName (string) – Site Design’s Name of the profile to create NFV profile .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a NFV Network profile .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • id (basestring) – id path parameter. Id of the NFV profile to be updated .

  • name (basestring) – name query parameter. Name of the profile to be updated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

API to get NFV network profile. .

Parameters:
  • id (basestring) – id path parameter. ID of network profile to retrieve. .

  • offset (basestring, int) – offset query parameter. offset/starting row .

  • limit (basestring, int) – limit query parameter. Number of profile to be retrieved .

  • name (basestring) – name query parameter. Name of network profile to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_nfv_profile(id, name=None, headers=None, **request_parameters)[source]

API to delete nfv network profile. .

Parameters:
  • id (basestring) – id path parameter. Id of nfv network profile to delete. .

  • name (basestring) – name query parameter. Nameof nfv network profile to delete. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

sites

class Sites[source]

Cisco DNA Center Sites API (version: 2.3.3.0).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

assign_devices_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns unassigned devices to a site. This API does not move assigned devices to other sites. .

Parameters:
  • device (list) – Sites’s device (list of objects).

  • site_id (basestring) – siteId path parameter. Site id to which site the device to assign .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_membership(site_id, device_family=None, limit=None, offset=None, serial_number=None, headers=None, **request_parameters)[source]

Getting the site children details and device details. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to retrieve device associated with the site. .

  • offset (basestring, int) – offset query parameter. offset/starting row .

  • limit (basestring, int) – limit query parameter. Number of sites to be retrieved .

  • device_family (basestring) – deviceFamily query parameter. Device family name .

  • serial_number (basestring) – serialNumber query parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy. .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type of site to create (eg: area, building, floor) . Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site using siteNameHierarchy/siteId/type ,return all sites if these parameters are not given as input. .

Parameters:
  • name (basestring) – name query parameter. siteNameHierarchy (ex: global/groupName) .

  • site_id (basestring) – siteId query parameter. Site id to which site details to retrieve. .

  • type (basestring) – type query parameter. type (ex: area, building, floor) .

  • offset (basestring, int) – offset query parameter. offset/starting row. The default value is 1 .

  • limit (basestring, int) – limit query parameter. Number of sites to be retrieved. The default value is 500 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_health(limit=None, offset=None, site_type=None, timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required .

  • site_type (basestring) – siteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA .

  • offset (basestring, int) – offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. .

  • limit (basestring, int) – limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve site count. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – siteId path parameter. Site id to which site details to be updated. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to which site details to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 2.3.3.0).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash .

Parameters:
  • schedule_validate (bool) – scheduleValidate query parameter. scheduleValidate, validates data before schedule (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order=None, version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%” .

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus query parameter. imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED .

  • version (basestring) – version query parameter. software Image Version .

  • image_series (basestring) – imageSeries query parameter. image Series .

  • image_name (basestring) – imageName query parameter. image Name .

  • is_tagged_golden (bool) – isTaggedGolden query parameter. is Tagged Golden .

  • is_cco_recommended (bool) – isCCORecommended query parameter. is recommended from cisco.com .

  • is_cco_latest (bool) – isCCOLatest query parameter. is latest from cisco.com .

  • created_time (int) – createdTime query parameter. time in milliseconds (epoch format) .

  • image_size_greater_than (int) – imageSizeGreaterThan query parameter. size in bytes .

  • image_size_lesser_than (int) – imageSizeLesserThan query parameter. size in bytes .

  • sort_by (basestring) – sortBy query parameter. sort results by this field .

  • sort_order (basestring) – sortOrder query parameter. sort order ‘asc’ or ‘des’. Default is asc .

  • limit (basestring, int) – limit query parameter.

  • offset (basestring, int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_device_family_identifiers(headers=None, **request_parameters)[source]

API to get Device Family Identifiers for all Device Families that can be used for tagging an image golden. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag_as_golden_image(deviceFamilyIdentifier=None, deviceRole=None, imageId=None, siteId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Golden Tag image. Set siteId as -1 for Global site. .

Parameters:
  • deviceFamilyIdentifier (string) – Software Image Management (SWIM)’s Device Family Identifier e.g. : 277696480-283933147, 277696480 .

  • deviceRole (string) – Software Image Management (SWIM)’s Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • imageId (string) – Software Image Management (SWIM)’s imageId in uuid format. .

  • siteId (string) – Software Image Management (SWIM)’s SiteId in uuid format. For Global Site “-1” to be used. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_golden_tag_for_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)[source]

Remove golden tag. Set siteId as -1 for Global site. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

  • device_family_identifier (basestring) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

  • device_role (basestring) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • image_id (basestring) – imageId path parameter. Image Id in uuid format. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_golden_tag_status_of_an_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)[source]

Get golden tag status of an image. Set siteId as -1 for Global site. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

  • device_family_identifier (basestring) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

  • device_role (basestring) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • image_id (basestring) – imageId path parameter. Image Id in uuid format. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2. Upload the file to the file form data field .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – isThirdParty query parameter. Third party Image check .

  • third_party_vendor (basestring) – thirdPartyVendor query parameter. Third Party Vendor .

  • third_party_image_family (basestring) – thirdPartyImageFamily query parameter. Third Party image family .

  • third_party_application_type (basestring) – thirdPartyApplicationType query parameter. Third Party Application Type .

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2 .

Parameters:
  • schedule_at (basestring) – scheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – scheduleDesc query parameter. Custom Description (Optional) .

  • schedule_origin (basestring) – scheduleOrigin query parameter. Originator of this call (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

system_settings

class SystemSettings[source]

Cisco DNA Center System Settings API (version: 2.3.3.0).

Wraps the DNA Center System Settings API and exposes the API as native Python methods that return native Python objects.

custom_prompt_support_get_api(headers=None, **request_parameters)[source]

Returns supported custom prompts by Cisco DNA Center .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

custom_prompt_post_api(passwordPrompt=None, usernamePrompt=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Save custom prompt added by user in Cisco DNA Center. API will always override the existing prompts. User should provide all the custom prompt in case of any update .

Parameters:
  • passwordPrompt (string) – System Settings’s Password Prompt.

  • usernamePrompt (string) – System Settings’s Username Prompt.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

tag

class Tag[source]

Cisco DNA Center Tag API (version: 2.3.3.0).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria .

Parameters:
  • name (basestring) – name query parameter. Tag name is mandatory when filter operation is used. .

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • field (basestring) – field query parameter. Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’ .

  • sort_by (basestring) – sortBy query parameter. Only supported attribute is name. SortyBy is mandatory when order is used. .

  • order (basestring) – order query parameter. Available values are asc and des .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count .

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API .

Parameters:
  • memberToTags (list) – Tag’s memberToTags (list of objects).

  • memberType (string) – Tag’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_members_by_id(id, member_type, level=None, limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API .

  • offset (basestring, int) – offset query parameter. Used for pagination. It indicates the starting row number out of available member records .

  • limit (basestring, int) – limit query parameter. Used to Number of maximum members to return in the result .

  • member_association_type (basestring) – memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag .

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

add_members_to_the_tag(id, object=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id .

Parameters:
  • object (string) – Tag’s object.

  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tag_member_count(id, member_type, level=None, member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_id (basestring) – memberId path parameter. TagMember id to be removed from tag .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

task

class Task[source]

Cisco DNA Center Task API (version: 2.3.3.0).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_business_api_execution_details(execution_id, headers=None, **request_parameters)[source]

Retrieves the execution details of a Business API .

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution Id of API .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • offset (basestring, int) – offset query parameter.

  • limit (basestring, int) – limit query parameter.

  • sort_by (basestring) – sortBy query parameter. Sort results by this field .

  • order (basestring) – order query parameter. Sort order asc or dsc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid .

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (basestring, int) – offset path parameter. Index, minimum value is 0 .

  • limit (basestring, int) – limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

topology

class Topology[source]

Cisco DNA Center Topology API (version: 2.3.3.0).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Network health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID .

Parameters:
  • vlan_id (basestring) – vlanID path parameter. Vlan Name for e.g Vlan1, Vlan23 etc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol .

Parameters:
  • topology_type (basestring) – topologyType path parameter. Type of topology(OSPF,ISIS,etc) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType .

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

users

class Users[source]

Cisco DNA Center Users API (version: 2.3.3.0).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 2.3.3.0).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

sensor_test_results(end_time=None, site_id=None, start_time=None, test_failure_by=None, headers=None, **request_parameters)[source]

Intent API to get SENSOR test result summary .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID .

  • start_time (int) – startTime query parameter. The epoch time in milliseconds .

  • end_time (int) – endTime query parameter. The epoch time in milliseconds .

  • test_failure_by (basestring) – testFailureBy query parameter. Obtain failure statistics group by “area”, “building”, or “floor” .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites .

Parameters:
  • enableFabric (boolean) – Wireless’s Enable SSID for Fabric .

  • flexConnect (object) – Wireless’s flexConnect.

  • managedAPLocations (list) – Wireless’s Managed AP Locations (Enter entire Site(s) hierarchy) (list of strings).

  • ssidDetails (object) – Wireless’s ssidDetails.

  • ssidType (string) – Wireless’s SSID Type . Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center .

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName query parameter. Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, nasOptions=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout.

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcase SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service.

  • enableFastLane (boolean) – Wireless’s Enable FastLane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List.

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client. Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s SSID NAME .

  • nasOptions (list) – Wireless’s Nas Options (list of strings).

  • passphrase (string) – Wireless’s Passphrase .

  • radioPolicy (string) – Wireless’s Radio Policy Enum (enum: Triple band operation (2.4GHz, 5GHz and 6GHz), Triple band operation with band select, 5GHz only, 2.4GHz only, 6GHz only) . Available values are ‘Triple band operation (2.4GHz, 5GHz and 6GHz)’, ‘Triple band operation with band select’, ‘5GHz only’, ‘2.4GHz only’ and ‘6GHz only’.

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’, ‘OPEN’, ‘WPA3_ENTERPRISE’, ‘WPA3_PERSONAL’, ‘WPA2_WPA3_PERSONAL’ and ‘WPA2_WPA3_ENTERPRISE’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type Enum (voicedata or data ) . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, nasOptions=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout.

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcase SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service.

  • enableFastLane (boolean) – Wireless’s Enable FastLane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List.

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client. Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s SSID NAME .

  • nasOptions (list) – Wireless’s Nas Options (list of strings).

  • passphrase (string) – Wireless’s Passphrase .

  • radioPolicy (string) – Wireless’s Radio Policy Enum (enum: Triple band operation (2.4GHz, 5GHz and 6GHz), Triple band operation with band select, 5GHz only, 2.4GHz only, 6GHz only) . Available values are ‘Triple band operation (2.4GHz, 5GHz and 6GHz)’, ‘Triple band operation with band select’, ‘5GHz only’, ‘2.4GHz only’ and ‘6GHz only’.

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’, ‘OPEN’, ‘WPA3_ENTERPRISE’, ‘WPA3_PERSONAL’, ‘WPA2_WPA3_PERSONAL’ and ‘WPA2_WPA3_ENTERPRISE’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type Enum (voicedata or data ) . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName path parameter. Enter the SSID name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from Cisco DNA Center whose name is provided. .

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter. Wireless Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Access Point Provision and ReProvision .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_update_dynamic_interface(interfaceName=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create or update an dynamic interface .

Parameters:
  • interfaceName (string) – Wireless’s dynamic-interface name .

  • vlanId (number) – Wireless’s Vlan Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_dynamic_interface(interface_name=None, headers=None, **request_parameters)[source]

Get one or all dynamic interface(s) .

Parameters:
  • interface_name (basestring) – interface-name query parameter. dynamic-interface name, if not specified all the existing dynamic interfaces will be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_dynamic_interface(interface_name, headers=None, **request_parameters)[source]

Delete a dynamic interface .

Parameters:
  • interface_name (basestring) – interfaceName path parameter. valid interface-name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on Cisco DNA Center and associates sites and SSIDs to it. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile. .

Parameters:
  • profile_name (basestring) – profileName query parameter. Wireless Network Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

psk_override(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update/override pass phrase of enterprise SSID .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles .

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter. RF Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, enableRadioTypeC=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, radioTypeCProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile .

Parameters:
  • channelWidth (string) – Wireless’s Channel Width .

  • defaultRfProfile (boolean) – Wireless’s is Default Rf Profile .

  • enableBrownField (boolean) – Wireless’s Enable Brown Field .

  • enableCustom (boolean) – Wireless’s Enable Custom .

  • enableRadioTypeA (boolean) – Wireless’s Enable Radio Type A .

  • enableRadioTypeB (boolean) – Wireless’s Enable Radio Type B .

  • enableRadioTypeC (boolean) – Wireless’s Enable Radio Type C (6GHz) .

  • name (string) – Wireless’s RF Profile Name .

  • radioTypeAProperties (object) – Wireless’s radioTypeAProperties.

  • radioTypeBProperties (object) – Wireless’s radioTypeBProperties.

  • radioTypeCProperties (object) – Wireless’s radioTypeCProperties.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s) .

Parameters:
  • rf_profile_name (basestring) – rfProfileName path parameter. RF profile name to be deleted(required) non- custom RF profile cannot be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

DNACenterAPI v2.3.5.3

application_policy

class ApplicationPolicy[source]

Cisco DNA Center Application Policy API (version: 2.3.5.3).

Wraps the DNA Center Application Policy API and exposes the API as native Python methods that return native Python objects.

get_application_policy(policy_scope=None, headers=None, **request_parameters)[source]

Get all existing application policies .

Parameters:
  • policy_scope (basestring) – policyScope query parameter. policy scope name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-application-policy

get_application_policy_default(headers=None, **request_parameters)[source]

Get default application policy .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-application-policy-default

application_policy_intent(createList=None, deleteList=None, updateList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Update/Delete application policy .

Parameters:
  • createList (list) – Application Policy’s createList (list of objects).

  • deleteList (list) – Application Policy’s Delete list of Group Based Policy ids (list of strings).

  • updateList (list) – Application Policy’s updateList (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!application-policy-intent

get_application_policy_queuing_profile(name=None, headers=None, **request_parameters)[source]

Get all or by name, existing application policy queuing profiles .

Parameters:
  • name (basestring) – name query parameter. queuing profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-application-policy-queuing-profile

update_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update existing custom application queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-application-policy-queuing-profile

create_application_policy_queuing_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-application-policy-queuing-profile

get_application_policy_queuing_profile_count(headers=None, **request_parameters)[source]

Get the number of all existing application policy queuing profile .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-application-policy-queuing-profile-count

delete_application_policy_queuing_profile(id, headers=None, **request_parameters)[source]

Delete existing custom application policy queuing profile by id .

Parameters:
  • id (basestring) – id path parameter. Id of custom queuing profile to delete .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-application-policy-queuing-profile

get_application_sets(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get appllication-sets by offset/limit or by name .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-application-sets

delete_application_set(id, headers=None, **request_parameters)[source]

Delete existing application-set by it’s id .

Parameters:
  • id (basestring) – id query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-application-set

create_application_set(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new custom application-set/s .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-application-set

get_application_sets_count(headers=None, **request_parameters)[source]

Get the number of existing application-sets .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-application-sets-count

create_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create new Custom application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-application

edit_application(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Edit the attributes of an existing application .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!edit-application

delete_application(id, headers=None, **request_parameters)[source]

Delete existing application by its id .

Parameters:
  • id (basestring) – id query parameter. Application’s Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-application

get_applications(limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Get applications by offset/limit or by name .

Parameters:
  • offset (int) – offset query parameter. The offset of the first application to be returned .

  • limit (int) – limit query parameter. The maximum number of applications to be returned .

  • name (basestring) – name query parameter. Application’s name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-applications

get_applications_count(headers=None, **request_parameters)[source]

Get the number of all existing applications .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-applications-count

get_qos_device_interface_info(network_device_id=None, headers=None, **request_parameters)[source]

Get all or by network device id, existing qos device interface infos .

Parameters:
  • network_device_id (basestring) – networkDeviceId query parameter. network device id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-qos-device-interface-info

update_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update existing qos device interface infos associate with network device id .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-qos-device-interface-info

create_qos_device_interface_info(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create qos device interface infos associate with network device id to allow the user to mark specific interfaces as WAN, to associate WAN interfaces with specific SP Profile and to be able to define a shaper on WAN interfaces .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-qos-device-interface-info

get_qos_device_interface_info_count(headers=None, **request_parameters)[source]

Get the number of all existing qos device interface infos group by network device id .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-qos-device-interface-info-count

delete_qos_device_interface_info(id, headers=None, **request_parameters)[source]

Delete all qos device interface infos associate with network device id .

Parameters:
  • id (basestring) – id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-qos-device-interface-info

applications

class Applications[source]

Cisco DNA Center Applications API (version: 2.3.5.3).

Wraps the DNA Center Applications API and exposes the API as native Python methods that return native Python objects.

applications(application_health=None, application_name=None, device_id=None, end_time=None, limit=None, mac_address=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of applications for a specific site, a device, or a client device’s MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints. .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac) .

  • device_id (basestring) – deviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac) .

  • mac_address (basestring) – macAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId) .

  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of time window .

  • application_health (basestring) – applicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only) .

  • offset (int) – offset query parameter. The offset of the first application in the returned data (optionally used with siteId only) .

  • limit (int) – limit query parameter. The max number of application entries in returned data [1, 1000] (optionally used with siteId only) .

  • application_name (basestring) – applicationName query parameter. The name of the application to get information on .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!applications

authentication_management

class AuthenticationManagement[source]

Cisco DNA Center Authentication Management API (version: 2.3.5.3).

Wraps the DNA Center Authentication Management API and exposes the API as native Python methods that return native Python objects.

import_certificate(multipart_fields, multipart_monitor_callback, list_of_users=None, pk_password=None, headers=None, **request_parameters)[source]

This method is used to upload a certificate .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • pk_password (basestring) – pkPassword query parameter. Private Key Passsword .

  • list_of_users (basestring, list, set, tuple) – listOfUsers query parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-certificate

import_certificate_p12(multipart_fields, multipart_monitor_callback, list_of_users=None, p12_password=None, pk_password=None, headers=None, **request_parameters)[source]

This method is used to upload a PKCS#12 file .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • p12_password (basestring) – p12Password query parameter. P12 Passsword .

  • pk_password (basestring) – pkPassword query parameter. Private Key Passsword .

  • list_of_users (basestring, list, set, tuple) – listOfUsers query parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-certificate-p12

authentication_api(headers=None, **request_parameters)[source]

API to obtain an access token, which remains valid for 1 hour. The token obtained using this API is required to be set as value to the X-Auth-Token HTTP Header for all API calls to Cisco DNA Center. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!authentication-api

cisco_dna_center_system

class CiscoDnaCenterSystem[source]

Cisco DNA Center Cisco DNA Center System API (version: 2.3.5.3).

Wraps the DNA Center Cisco DNA Center System API and exposes the API as native Python methods that return native Python objects.

authorize_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Authorizes one of more devices. A device can only be authorized if Authorization is set in Device Settings. .

Parameters:
  • deviceIdList (list) – Cisco DNA Center System’s Device Id List (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!authorize-device

clients

class Clients[source]

Cisco DNA Center Clients API (version: 2.3.5.3).

Wraps the DNA Center Clients API and exposes the API as native Python methods that return native Python objects.

get_client_detail(mac_address, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Client information retrieved by Mac Address for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • mac_address (basestring) – macAddress query parameter. MAC Address of the client .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-client-detail

get_client_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-client-enrichment-details

get_overall_client_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-overall-client-health

client_proximity(username, number_days=None, time_resolution=None, headers=None, **request_parameters)[source]

This intent API will provide client proximity information for a specific wireless user. Proximity is defined as presence on the same floor at the same time as the specified wireless user. The Proximity workflow requires the subscription to the following event (via the Event Notification workflow) prior to making this API call: NETWORK-CLIENTS-3-506 Client Proximity Report. .

Parameters:
  • username (basestring) – username query parameter. Wireless client username for which proximity information is required .

  • number_days (int) – number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days. .

  • time_resolution (int) – time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!client-proximity

command_runner

class CommandRunner[source]

Cisco DNA Center Command Runner API (version: 2.3.5.3).

Wraps the DNA Center Command Runner API and exposes the API as native Python methods that return native Python objects.

get_all_keywords_of_clis_accepted(headers=None, **request_parameters)[source]

Get valid keywords .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-keywords-of-clis-accepted

run_read_only_commands_on_devices(commands=None, description=None, deviceUuids=None, name=None, timeout=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Submit request for read-only CLIs .

Parameters:
  • commands (list) – Command Runner’s commands (list of strings).

  • description (string) – Command Runner’s description.

  • deviceUuids (list) – Command Runner’s deviceUuids (list of strings).

  • name (string) – Command Runner’s name.

  • timeout (integer) – Command Runner’s timeout.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!run-read-only-commands-on-devices

compliance

class Compliance[source]

Cisco DNA Center Compliance API (version: 2.3.5.3).

Wraps the DNA Center Compliance API and exposes the API as native Python methods that return native Python objects.

get_compliance_status_(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link: https://developer.cisco.com/docs/dna-center/#!get-compliance-status

get_compliance_status(compliance_status=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return compliance status of device(s). .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can be have value among ‘COMPLIANT’,’NON_COMPLIANT’,’IN_PROGRESS’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-compliance-status

run_compliance(categories=None, deviceUuids=None, triggerFull=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Run compliance check for device(s). .

Parameters:
  • categories (list) – Compliance’s categories (list of strings).

  • deviceUuids (list) – Compliance’s deviceUuids (list of strings).

  • triggerFull (boolean) – Compliance’s triggerFull.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!run-compliance

get_compliance_status_count(compliance_status=None, headers=None, **request_parameters)[source]

Return Compliance Status Count .

Parameters:
  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-compliance-status-count

get_compliance_detail(compliance_status=None, compliance_type=None, device_uuid=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Return Compliance Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’ .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • device_uuid (basestring) – deviceUuid query parameter. Comma separated deviceUuids .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of records to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-compliance-detail

get_compliance_detail_count(compliance_status=None, compliance_type=None, headers=None, **request_parameters)[source]

Return Compliance Count Detail .

Parameters:
  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_PROFILE’, ‘IMAGE’, ‘APPLICATION_VISIBILITY’, ‘FABRIC’, ‘PSIRT’, ‘RUNNING_CONFIG’, ‘WORKFLOW’. .

  • compliance_status (basestring) – complianceStatus query parameter. Compliance status can have value among ‘COMPLIANT’, ‘NON_COMPLIANT’, ‘IN_PROGRESS’, ‘NOT_AVAILABLE’, ‘NOT_APPLICABLE’, ‘ERROR’ .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-compliance-detail-count

device_compliance_status(device_uuid, headers=None, **request_parameters)[source]

Return compliance status of a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-compliance-status

compliance_details_of_device(device_uuid, category=None, compliance_type=None, diff_list=None, key=None, value=None, headers=None, **request_parameters)[source]

Return compliance detailed report for a device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • category (basestring) – category query parameter. complianceCategory can have any value among ‘INTENT’, ‘RUNNING_CONFIG’ .

  • compliance_type (basestring) – complianceType query parameter. complianceType can have any value among ‘NETWORK_DESIGN’, ‘NETWORK_PROFILE’, ‘FABRIC’, ‘POLICY’, ‘RUNNING_CONFIG’ .

  • diff_list (bool) – diffList query parameter. diff list [ pass true to fetch the diff list ] .

  • key (basestring) – key query parameter. extended attribute key .

  • value (basestring) – value query parameter. extended attribute value .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!compliance-details-of-device

configuration_archive

class ConfigurationArchive[source]

Cisco DNA Center Configuration Archive API (version: 2.3.5.3).

Wraps the DNA Center Configuration Archive API and exposes the API as native Python methods that return native Python objects.

export_device_configurations(deviceId=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Export Device configurations to an encrypted zip file. .

Parameters:
  • deviceId (list) – Configuration Archive’s Device Id (list of strings).

  • password (string) – Configuration Archive’s Password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-device-configurations

configuration_templates

class ConfigurationTemplates[source]

Cisco DNA Center Configuration Templates API (version: 2.3.5.3).

Wraps the DNA Center Configuration Templates API and exposes the API as native Python methods that return native Python objects.

clone_given_template(name, project_id, template_id, headers=None, **request_parameters)[source]

API to clone template .

Parameters:
  • name (basestring) – name path parameter. Template name to clone template(Name should be different than existing template name within same project) .

  • template_id (basestring) – templateId path parameter. UUID of the template to clone it .

  • project_id (basestring) – projectId path parameter.

  • project_id – projectId query parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!clone-given-template

create_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to create a new project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (object) – Configuration Templates’s List of templates within the project .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-project

update_project(createTime=None, description=None, id=None, lastUpdateTime=None, name=None, tags=None, templates=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API is used to update an existing project. .

Parameters:
  • createTime (integer) – Configuration Templates’s Create time of project .

  • description (string) – Configuration Templates’s Description of project .

  • id (string) – Configuration Templates’s UUID of project .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of project .

  • name (string) – Configuration Templates’s Name of project .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templates (object) – Configuration Templates’s List of templates within the project .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-project

get_projects(name=None, sort_order=None, headers=None, **request_parameters)[source]

List the projects .

Parameters:
  • name (basestring) – name query parameter. Name of project to be searched .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-projects

imports_the_projects_provided(do_version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Imports the Projects provided in the DTO .

Parameters:
  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload ((list, dict)) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!imports-the-projects-provided

export_projects(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the projects for given projectNames. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-projects

imports_the_templates_provided(project_name, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, do_version=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Imports the templates provided in the DTO by project Name .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • project_name (basestring) – projectName path parameter. Project name to create template under the project .

  • do_version (bool) – doVersion query parameter. If this flag is true then it creates a new version of the template with the imported contents in case if the templates already exists. ” If this flag is false and if template already exists, then operation fails with ‘Template already exists’ error .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!imports-the-templates-provided

get_project_details(project_id, headers=None, **request_parameters)[source]

Get the details of the given project by its id. .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to get project details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-project-details

deletes_the_project(project_id, headers=None, **request_parameters)[source]

Deletes the project by its id .

Parameters:
  • project_id (basestring) – projectId path parameter. projectId(UUID) of project to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deletes-the-project

create_template(project_id, author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a template by project id. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • project_id (basestring) – projectId path parameter. UUID of the project in which the template needs to be created .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-template

gets_the_templates_available(filter_conflicting_templates=None, product_family=None, product_series=None, product_type=None, project_id=None, project_names=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)[source]

List the templates available .

Parameters:
  • project_id (basestring) – projectId query parameter. Filter template(s) based on project UUID .

  • software_type (basestring) – softwareType query parameter. Filter template(s) based software type .

  • software_version (basestring) – softwareVersion query parameter. Filter template(s) based softwareVersion .

  • product_family (basestring) – productFamily query parameter. Filter template(s) based on device family .

  • product_series (basestring) – productSeries query parameter. Filter template(s) based on device series .

  • product_type (basestring) – productType query parameter. Filter template(s) based on device type .

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

  • tags (basestring, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

  • project_names (basestring, list, set, tuple) – projectNames query parameter. Filter template(s) based on project names .

  • un_committed (bool) – unCommitted query parameter. Filter template(s) based on template commited or not .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-the-templates-available

update_template(author=None, composite=None, containingTemplates=None, createTime=None, customParamsOrder=None, description=None, deviceTypes=None, failurePolicy=None, id=None, language=None, lastUpdateTime=None, latestVersionTime=None, name=None, parentTemplateId=None, projectId=None, projectName=None, rollbackTemplateContent=None, rollbackTemplateParams=None, softwareType=None, softwareVariant=None, softwareVersion=None, tags=None, templateContent=None, templateParams=None, validationErrors=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a template. .

Parameters:
  • author (string) – Configuration Templates’s Author of template .

  • composite (boolean) – Configuration Templates’s Is it composite template .

  • containingTemplates (list) – Configuration Templates’s containingTemplates (list of objects).

  • createTime (integer) – Configuration Templates’s Create time of template .

  • customParamsOrder (boolean) – Configuration Templates’s Custom Params Order .

  • description (string) – Configuration Templates’s Description of template .

  • deviceTypes (list) – Configuration Templates’s deviceTypes (list of objects).

  • failurePolicy (string) – Configuration Templates’s Define failure policy if template provisioning fails . Available values are ‘ABORT_ON_ERROR’, ‘CONTINUE_ON_ERROR’, ‘ROLLBACK_ON_ERROR’, ‘ROLLBACK_TARGET_ON_ERROR’ and ‘ABORT_TARGET_ON_ERROR’.

  • id (string) – Configuration Templates’s UUID of template .

  • language (string) – Configuration Templates’s Template language (JINJA or VELOCITY) .

  • lastUpdateTime (integer) – Configuration Templates’s Update time of template .

  • latestVersionTime (integer) – Configuration Templates’s Latest versioned template time .

  • name (string) – Configuration Templates’s Name of template .

  • parentTemplateId (string) – Configuration Templates’s Parent templateID .

  • projectId (string) – Configuration Templates’s Project UUID .

  • projectName (string) – Configuration Templates’s Project name .

  • rollbackTemplateContent (string) – Configuration Templates’s Rollback template content .

  • rollbackTemplateParams (list) – Configuration Templates’s rollbackTemplateParams (list of objects).

  • softwareType (string) – Configuration Templates’s Applicable device software type .

  • softwareVariant (string) – Configuration Templates’s Applicable device software variant .

  • softwareVersion (string) – Configuration Templates’s Applicable device software version .

  • tags (list) – Configuration Templates’s tags (list of objects).

  • templateContent (string) – Configuration Templates’s Template content .

  • templateParams (list) – Configuration Templates’s templateParams (list of objects).

  • validationErrors (object) – Configuration Templates’s validationErrors.

  • version (string) – Configuration Templates’s Current version of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-template

deploy_template(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (string) – Configuration Templates’s memberTemplateDeploymentInfo .

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deploy-template

get_template_deployment_status(deployment_id, headers=None, **request_parameters)[source]

API to retrieve the status of template deployment. .

Parameters:
  • deployment_id (basestring) – deploymentId path parameter. UUID of deployment to retrieve template deployment status .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-template-deployment-status

export_templates(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the templates for given templateIds. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-templates

preview_template(deviceId=None, params=None, resourceParams=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to preview a template. .

Parameters:
  • deviceId (string) – Configuration Templates’s UUID of device to get template preview .

  • params (object) – Configuration Templates’s Params to render preview .

  • resourceParams (object) – Configuration Templates’s Resource params to render preview .

  • templateId (string) – Configuration Templates’s UUID of template to get template preview .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!preview-template

version_template(comments=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to version the current contents of the template. .

Parameters:
  • comments (string) – Configuration Templates’s Template version comments .

  • templateId (string) – Configuration Templates’s UUID of template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!version-template

get_template_versions(template_id, headers=None, **request_parameters)[source]

Get all the versions of template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) to get list of versioned templates .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-template-versions

deletes_the_template(template_id, headers=None, **request_parameters)[source]

Deletes the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. templateId(UUID) of template to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deletes-the-template

get_template_details(template_id, latest_version=None, headers=None, **request_parameters)[source]

Details of the template by its id .

Parameters:
  • template_id (basestring) – templateId path parameter. TemplateId(UUID) to get details of the template .

  • latest_version (bool) – latestVersion query parameter. latestVersion flag to get the latest versioned template .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-template-details

get_projects_details(id=None, limit=None, name=None, offset=None, sort_order=None, headers=None, **request_parameters)[source]

Get project(s) details .

Parameters:
  • id (basestring) – id query parameter. Id of project to be searched .

  • name (basestring) – name query parameter. Name of project to be searched .

  • offset (int) – offset query parameter. Index of first result .

  • limit (int) – limit query parameter. Limits number of results .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-projects-details

get_templates_details(all_template_attributes=None, filter_conflicting_templates=None, id=None, include_version_details=None, limit=None, name=None, offset=None, product_family=None, product_series=None, product_type=None, project_id=None, project_name=None, software_type=None, software_version=None, sort_order=None, tags=None, un_committed=None, headers=None, **request_parameters)[source]

Get template(s) details .

Parameters:
  • id (basestring) – id query parameter. Id of template to be searched .

  • name (basestring) – name query parameter. Name of template to be searched .

  • project_id (basestring) – projectId query parameter. Filter template(s) based on project id .

  • project_name (basestring) – projectName query parameter. Filter template(s) based on project name .

  • software_type (basestring) – softwareType query parameter. Filter template(s) based software type .

  • software_version (basestring) – softwareVersion query parameter. Filter template(s) based softwareVersion .

  • product_family (basestring) – productFamily query parameter. Filter template(s) based on device family .

  • product_series (basestring) – productSeries query parameter. Filter template(s) based on device series .

  • product_type (basestring) – productType query parameter. Filter template(s) based on device type .

  • filter_conflicting_templates (bool) – filterConflictingTemplates query parameter. Filter template(s) based on confliting templates .

  • tags (basestring, list, set, tuple) – tags query parameter. Filter template(s) based on tags .

  • un_committed (bool) – unCommitted query parameter. Return uncommitted template .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .

  • all_template_attributes (bool) – allTemplateAttributes query parameter. Return all template attributes .

  • include_version_details (bool) – includeVersionDetails query parameter. Include template version details .

  • offset (int) – offset query parameter. Index of first result .

  • limit (int) – limit query parameter. Limits number of results .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-templates-details

deploy_template_v2(forcePushTemplate=None, isComposite=None, mainTemplateId=None, memberTemplateDeploymentInfo=None, targetInfo=None, templateId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

V2 API to deploy a template. .

Parameters:
  • forcePushTemplate (boolean) – Configuration Templates’s forcePushTemplate.

  • isComposite (boolean) – Configuration Templates’s Composite template flag .

  • mainTemplateId (string) – Configuration Templates’s Main template UUID of versioned template .

  • memberTemplateDeploymentInfo (string) – Configuration Templates’s memberTemplateDeploymentInfo .

  • targetInfo (list) – Configuration Templates’s targetInfo (list of objects).

  • templateId (string) – Configuration Templates’s UUID of template to be provisioned .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deploy-template-v2

device_onboarding_pnp

class DeviceOnboardingPnp[source]

Cisco DNA Center Device Onboarding (PnP) API (version: 2.3.5.3).

Wraps the DNA Center Device Onboarding (PnP) API and exposes the API as native Python methods that return native Python objects.

add_device(_id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a device to the PnP database. .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-device

get_device_list(cm_state=None, hostname=None, last_contact=None, limit=None, mac_address=None, name=None, offset=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, site_name=None, smart_account_id=None, sort=None, sort_order=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (int) – limit query parameter. Limits number of results .

  • offset (int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • mac_address (basestring) – macAddress query parameter. Device Mac Address .

  • hostname (basestring) – hostname query parameter. Device Hostname .

  • site_name (basestring) – siteName query parameter. Device Site Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-list

claim_device(configFileUrl=None, configId=None, deviceClaimList=None, fileServiceId=None, imageId=None, imageUrl=None, populateInventory=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claims one of more devices with specified workflow .

Parameters:
  • configFileUrl (string) – Device Onboarding (PnP)’s configFileUrl.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • deviceClaimList (list) – Device Onboarding (PnP)’s deviceClaimList (list of objects).

  • fileServiceId (string) – Device Onboarding (PnP)’s fileServiceId.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • imageUrl (string) – Device Onboarding (PnP)’s imageUrl.

  • populateInventory (boolean) – Device Onboarding (PnP)’s populateInventory.

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!claim-device

get_device_count(cm_state=None, last_contact=None, name=None, onb_state=None, pid=None, project_id=None, project_name=None, serial_number=None, smart_account_id=None, source=None, state=None, virtual_account_id=None, workflow_id=None, workflow_name=None, headers=None, **request_parameters)[source]

Returns the device count based on filter criteria. This is useful for pagination .

Parameters:
  • serial_number (basestring, list, set, tuple) – serialNumber query parameter. Device Serial Number .

  • state (basestring, list, set, tuple) – state query parameter. Device State .

  • onb_state (basestring, list, set, tuple) – onbState query parameter. Device Onboarding State .

  • cm_state (basestring, list, set, tuple) – cmState query parameter. Device Connection Manager State .

  • name (basestring, list, set, tuple) – name query parameter. Device Name .

  • pid (basestring, list, set, tuple) – pid query parameter. Device ProductId .

  • source (basestring, list, set, tuple) – source query parameter. Device Source .

  • project_id (basestring, list, set, tuple) – projectId query parameter. Device Project Id .

  • workflow_id (basestring, list, set, tuple) – workflowId query parameter. Device Workflow Id .

  • project_name (basestring, list, set, tuple) – projectName query parameter. Device Project Name .

  • workflow_name (basestring, list, set, tuple) – workflowName query parameter. Device Workflow Name .

  • smart_account_id (basestring, list, set, tuple) – smartAccountId query parameter. Device Smart Account .

  • virtual_account_id (basestring, list, set, tuple) – virtualAccountId query parameter. Device Virtual Account .

  • last_contact (bool) – lastContact query parameter. Device Has Contacted lastContact > 0 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-count

get_device_history(serial_number, sort=None, sort_order=None, headers=None, **request_parameters)[source]

Returns history for a specific device. Serial number is a required parameter .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Device Serial Number .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated list of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-history

import_devices_in_bulk(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add devices to PnP in bulk .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-devices-in-bulk

reset_device(deviceResetList=None, projectId=None, workflowId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Recovers a device from a Workflow Execution Error state .

Parameters:
  • deviceResetList (list) – Device Onboarding (PnP)’s deviceResetList (list of objects).

  • projectId (string) – Device Onboarding (PnP)’s projectId.

  • workflowId (string) – Device Onboarding (PnP)’s workflowId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!reset-device

get_sync_result_for_virtual_account(domain, name, headers=None, **request_parameters)[source]

Returns the summary of devices synced from the given smart account & virtual account with PnP .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • name (basestring) – name path parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-sync-result-for-virtual-account

claim_a_device_to_a_site(configInfo=None, deviceId=None, gateway=None, imageInfo=None, ipInterfaceName=None, rfProfile=None, sensorProfile=None, siteId=None, staticIP=None, subnetMask=None, type=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Claim a device based on DNA-C Site-based design process. Some required parameters differ based on device platform: Default/StackSwitch: imageInfo, configInfo. AccessPoints: rfProfile. Sensors: sensorProfile. CatalystWLC/MobilityExpress/EWC: staticIP, subnetMask, gateway. vlanId and ipInterfaceName are also allowed for Catalyst 9800 WLCs. .

Parameters:
  • configInfo (list) – Device Onboarding (PnP)’s configInfo (list of objects).

  • deviceId (string) – Device Onboarding (PnP)’s Device Id.

  • gateway (string) – Device Onboarding (PnP)’s for CatalystWLC/MobilityExpress .

  • imageInfo (object) – Device Onboarding (PnP)’s imageInfo.

  • ipInterfaceName (string) – Device Onboarding (PnP)’s for Catalyst 9800 WLC .

  • rfProfile (string) – Device Onboarding (PnP)’s for Access Points .

  • sensorProfile (string) – Device Onboarding (PnP)’s for Sensors .

  • siteId (string) – Device Onboarding (PnP)’s Site Id.

  • staticIP (string) – Device Onboarding (PnP)’s for CatalystWLC/MobilityExpress .

  • subnetMask (string) – Device Onboarding (PnP)’s for CatalystWLC/MobilityExpress .

  • type (string) – Device Onboarding (PnP)’s Type. Available values are ‘Default’, ‘StackSwitch’, ‘AccessPoint’, ‘Sensor’, ‘CatalystWLC’ and ‘MobilityExpress’.

  • vlanId (string) – Device Onboarding (PnP)’s for Catalyst 9800 WLC .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!claim-a-device-to-a-site

preview_config(deviceId=None, siteId=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Triggers a preview for site-based Day 0 Configuration .

Parameters:
  • deviceId (string) – Device Onboarding (PnP)’s deviceId.

  • siteId (string) – Device Onboarding (PnP)’s siteId.

  • type (string) – Device Onboarding (PnP)’s type. Available values are ‘Default’, ‘AccessPoint’, ‘StackSwitch’, ‘Sensor’ and ‘MobilityExpress’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!preview-config

un_claim_device(deviceIdList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Un-Claims one of more devices with specified workflow .

Parameters:
  • deviceIdList (list) – Device Onboarding (PnP)’s deviceIdList (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!un-claim-device

sync_virtual_account_devices(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-virtual-account-devices

update_device(id, _id=None, deviceInfo=None, runSummaryList=None, systemResetWorkflow=None, systemWorkflow=None, tenantId=None, version=None, workflow=None, workflowParameters=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates device details specified by device id in PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • deviceInfo (object) – Device Onboarding (PnP)’s deviceInfo.

  • runSummaryList (list) – Device Onboarding (PnP)’s runSummaryList (list of objects).

  • systemResetWorkflow (object) – Device Onboarding (PnP)’s systemResetWorkflow.

  • systemWorkflow (object) – Device Onboarding (PnP)’s systemWorkflow.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • workflow (object) – Device Onboarding (PnP)’s workflow.

  • workflowParameters (object) – Device Onboarding (PnP)’s workflowParameters.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device

delete_device_by_id_from_pnp(id, headers=None, **request_parameters)[source]

Deletes specified device from PnP database .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-by-id-from-pnp

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns device details specified by device id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-id

update_pnp_global_settings(_id=None, aaaCredentials=None, acceptEula=None, defaultProfile=None, savaMappingList=None, taskTimeOuts=None, tenantId=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the user’s list of global PnP settings .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • aaaCredentials (object) – Device Onboarding (PnP)’s aaaCredentials.

  • acceptEula (boolean) – Device Onboarding (PnP)’s acceptEula.

  • defaultProfile (object) – Device Onboarding (PnP)’s defaultProfile.

  • savaMappingList (list) – Device Onboarding (PnP)’s savaMappingList (list of objects).

  • taskTimeOuts (object) – Device Onboarding (PnP)’s taskTimeOuts.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-pnp-global-settings

get_pnp_global_settings(headers=None, **request_parameters)[source]

Returns global PnP settings of the user .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-pnp-global-settings

get_smart_account_list(headers=None, **request_parameters)[source]

Returns the list of Smart Account domains .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-smart-account-list

get_virtual_account_list(domain, headers=None, **request_parameters)[source]

Returns list of virtual accounts associated with the specified smart account .

Parameters:
  • domain (basestring) – domain path parameter. Smart Account Domain .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-virtual-account-list

add_virtual_account(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. The devices present in the registered virtual account are synced with the PnP database as well. The response payload returns the new profile .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-virtual-account

update_pnp_server_profile(autoSyncPeriod=None, ccoUser=None, expiry=None, lastSync=None, profile=None, smartAccountId=None, syncResult=None, syncResultStr=None, syncStartTime=None, syncStatus=None, tenantId=None, token=None, virtualAccountId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info .

Parameters:
  • autoSyncPeriod (integer) – Device Onboarding (PnP)’s autoSyncPeriod.

  • ccoUser (string) – Device Onboarding (PnP)’s ccoUser.

  • expiry (integer) – Device Onboarding (PnP)’s expiry.

  • lastSync (integer) – Device Onboarding (PnP)’s lastSync.

  • profile (object) – Device Onboarding (PnP)’s profile.

  • smartAccountId (string) – Device Onboarding (PnP)’s smartAccountId.

  • syncResult (object) – Device Onboarding (PnP)’s syncResult.

  • syncResultStr (string) – Device Onboarding (PnP)’s syncResultStr.

  • syncStartTime (integer) – Device Onboarding (PnP)’s syncStartTime.

  • syncStatus (string) – Device Onboarding (PnP)’s syncStatus. Available values are ‘NOT_SYNCED’, ‘SYNCING’, ‘SUCCESS’ and ‘FAILURE’.

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • token (string) – Device Onboarding (PnP)’s token.

  • virtualAccountId (string) – Device Onboarding (PnP)’s virtualAccountId.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-pnp-server-profile

deregister_virtual_account(domain, name, headers=None, **request_parameters)[source]

Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. The devices associated with the deregistered virtual account are removed from the PnP database as well. The response payload contains the deregistered smart & virtual account information .

Parameters:
  • domain (basestring) – domain query parameter. Smart Account Domain .

  • name (basestring) – name query parameter. Virtual Account Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deregister-virtual-account

get_workflows(limit=None, name=None, offset=None, sort=None, sort_order=None, type=None, headers=None, **request_parameters)[source]

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint .

Parameters:
  • limit (int) – limit query parameter. Limits number of results .

  • offset (int) – offset query parameter. Index of first result .

  • sort (basestring, list, set, tuple) – sort query parameter. Comma seperated lost of fields to sort on .

  • sort_order (basestring) – sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .

  • type (basestring, list, set, tuple) – type query parameter. Workflow Type .

  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflows

add_a_workflow(_id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-a-workflow

get_workflow_count(name=None, headers=None, **request_parameters)[source]

Returns the workflow count .

Parameters:
  • name (basestring, list, set, tuple) – name query parameter. Workflow Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflow-count

get_workflow_by_id(id, headers=None, **request_parameters)[source]

Returns a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-workflow-by-id

delete_workflow_by_id(id, headers=None, **request_parameters)[source]

Deletes a workflow specified by id .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-workflow-by-id

update_workflow(id, _id=None, addToInventory=None, addedOn=None, configId=None, currTaskIdx=None, description=None, endTime=None, execTime=None, imageId=None, instanceType=None, lastupdateOn=None, name=None, startTime=None, state=None, tasks=None, tenantId=None, type=None, useState=None, version=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing workflow .

Parameters:
  • _id (string) – Device Onboarding (PnP)’s _id.

  • addToInventory (boolean) – Device Onboarding (PnP)’s addToInventory.

  • addedOn (integer) – Device Onboarding (PnP)’s addedOn.

  • configId (string) – Device Onboarding (PnP)’s configId.

  • currTaskIdx (integer) – Device Onboarding (PnP)’s currTaskIdx.

  • description (string) – Device Onboarding (PnP)’s description.

  • endTime (integer) – Device Onboarding (PnP)’s endTime.

  • execTime (integer) – Device Onboarding (PnP)’s execTime.

  • imageId (string) – Device Onboarding (PnP)’s imageId.

  • instanceType (string) – Device Onboarding (PnP)’s instanceType. Available values are ‘SystemWorkflow’, ‘UserWorkflow’ and ‘SystemResetWorkflow’.

  • lastupdateOn (integer) – Device Onboarding (PnP)’s lastupdateOn.

  • name (string) – Device Onboarding (PnP)’s name.

  • startTime (integer) – Device Onboarding (PnP)’s startTime.

  • state (string) – Device Onboarding (PnP)’s state.

  • tasks (list) – Device Onboarding (PnP)’s tasks (list of objects).

  • tenantId (string) – Device Onboarding (PnP)’s tenantId.

  • type (string) – Device Onboarding (PnP)’s type.

  • useState (string) – Device Onboarding (PnP)’s useState.

  • version (integer) – Device Onboarding (PnP)’s version.

  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-workflow

device_replacement

class DeviceReplacement[source]

Cisco DNA Center Device Replacement API (version: 2.3.5.3).

Wraps the DNA Center Device Replacement API and exposes the API as native Python methods that return native Python objects.

return_replacement_devices_with_details(family=None, faulty_device_name=None, faulty_device_platform=None, faulty_device_serial_number=None, limit=None, offset=None, replacement_device_platform=None, replacement_device_serial_number=None, replacement_status=None, sort_by=None, sort_order=None, headers=None, **request_parameters)[source]

Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family. .

Parameters:
  • faulty_device_name (basestring) – faultyDeviceName query parameter. Faulty Device Name .

  • faulty_device_platform (basestring) – faultyDevicePlatform query parameter. Faulty Device Platform .

  • replacement_device_platform (basestring) – replacementDevicePlatform query parameter. Replacement Device Platform .

  • faulty_device_serial_number (basestring) – faultyDeviceSerialNumber query parameter. Faulty Device Serial Number .

  • replacement_device_serial_number (basestring) – replacementDeviceSerialNumber query parameter. Replacement Device Serial Number .

  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED] .

  • family (basestring, list, set, tuple) – family query parameter. List of families[Routers, Switches and Hubs, AP] .

  • sort_by (basestring) – sortBy query parameter. SortBy this field. SortBy is mandatory when order is used. .

  • sort_order (basestring) – sortOrder query parameter. Order on displayName[ASC,DESC] .

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-replacement-devices-with-details

unmark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

UnMarks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!unmark-device-for-replacement

mark_device_for_replacement(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Marks device for replacement .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!mark-device-for-replacement

return_replacement_devices_count(replacement_status=None, headers=None, **request_parameters)[source]

Get replacement devices count .

Parameters:
  • replacement_status (basestring, list, set, tuple) – replacementStatus query parameter. Device Replacement status list[READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-replacement-devices-count

deploy_device_replacement_workflow(faultyDeviceSerialNumber=None, replacementDeviceSerialNumber=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images .

Parameters:
  • faultyDeviceSerialNumber (string) – Device Replacement’s faultyDeviceSerialNumber.

  • replacementDeviceSerialNumber (string) – Device Replacement’s replacementDeviceSerialNumber.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deploy-device-replacement-workflow

devices

class Devices[source]

Cisco DNA Center Devices API (version: 2.3.5.3).

Wraps the DNA Center Devices API and exposes the API as native Python methods that return native Python objects.

get_planned_access_points_for_building(building_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)[source]

Provides a list of Planned Access Points for the Building it is requested for .

Parameters:
  • building_id (basestring) – buildingId path parameter. Building Id .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • radios (bool) – radios query parameter. inlcude planned radio details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-building

get_device_detail(identifier, search_by, timestamp=None, headers=None, **request_parameters)[source]

Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the device data is required .

  • search_by (basestring) – searchBy query parameter. MAC Address or Device Name value or UUID of the network device .

  • identifier (basestring) – identifier query parameter. One of keywords : macAddress or uuid or nwDeviceName .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-detail

get_device_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-enrichment-details

devices(device_role=None, end_time=None, health=None, limit=None, offset=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. .

Parameters:
  • device_role (basestring) – deviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP) .

  • site_id (basestring) – siteId query parameter. Assurance site UUID value .

  • health (basestring) – health query parameter. The device overall health (One of POOR, FAIR, GOOD) .

  • start_time (int) – startTime query parameter. UTC epoch time in milliseconds .

  • end_time (int) – endTime query parameter. UTC epoch time in miliseconds .

  • limit (int) – limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) .

  • offset (int) – offset query parameter. The offset of the first device in the returned data .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!devices

get_planned_access_points_for_floor(floor_id, limit=None, offset=None, radios=None, headers=None, **request_parameters)[source]

Provides a list of Planned Access Points for the Floor it is requested for .

Parameters:
  • floor_id (basestring) – floorId path parameter. Floor Id .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • radios (bool) – radios query parameter. inlcude planned radio details .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-planned-access-points-for-floor

get_all_interfaces(last_input_time=None, last_output_time=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns all available interfaces. This endpoint can return a maximum of 500 interfaces .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • last_input_time (basestring) – lastInputTime query parameter. Last Input Time .

  • last_output_time (basestring) – lastOutputTime query parameter. Last Output Time .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-interfaces

get_device_interface_count(headers=None, **request_parameters)[source]

Returns the count of interfaces for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interface-count

get_interface_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns list of interfaces for specified device management IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. IP address of the interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-by-ip

get_isis_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has ISIS enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-isis-interfaces

get_interface_info_by_id(device_id, headers=None, **request_parameters)[source]

Returns list of interfaces by specified device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-info-by-id

get_device_interface_count_by_id(device_id, headers=None, **request_parameters)[source]

Returns the interface count for the given device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interface-count-by-id

get_interface_details(device_id, name, headers=None, **request_parameters)[source]

Returns interface by specified device Id and interface name .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • name (basestring) – name query parameter. Interface name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-details

get_device_interfaces_by_specified_range(device_id, records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of interfaces for the device for the specified range .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interfaces-by-specified-range

get_ospf_interfaces(headers=None, **request_parameters)[source]

Returns the interfaces that has OSPF enabled .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ospf-interfaces

get_interface_by_id(id, headers=None, **request_parameters)[source]

Returns the interface for the given interface ID .

Parameters:
  • id (basestring) – id path parameter. Interface ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-interface-by-id

update_interface_details(interface_uuid, adminStatus=None, deployment_mode=None, description=None, vlanId=None, voiceVlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add/Update Interface description, VLAN membership, Voice VLAN and change Interface admin status (‘UP’/’DOWN’) from Request body. .

Parameters:
  • adminStatus (string) – Devices’s Admin Status.

  • description (string) – Devices’s Description.

  • vlanId (integer) – Devices’s Vlan Id.

  • voiceVlanId (integer) – Devices’s Voice Vlan Id.

  • interface_uuid (basestring) – interfaceUuid path parameter. Interface ID .

  • deployment_mode (basestring) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-interface-details

legit_operations_for_interface(interface_uuid, headers=None, **request_parameters)[source]

Get list of all properties & operations valid for an interface. .

Parameters:
  • interface_uuid (basestring) – interfaceUuid path parameter. Interface ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!legit-operations-for-interface

clear_mac_address_table(interface_uuid, deployment_mode=None, operation=None, payload=None, headers=None, active_validation=True, **request_parameters)[source]

Clear mac-address on an individual port. In request body, operation needs to be specified as ‘ClearMacAddress’. In the future more possible operations will be added to this API .

Parameters:
  • operation (string) – Devices’s Operation.

  • payload (dict) – Devices’s Payload.

  • interface_uuid (basestring) – interfaceUuid path parameter. Interface Id .

  • deployment_mode (basestring) – deploymentMode query parameter. Preview/Deploy [‘Preview’ means the configuration is not pushed to the device. ‘Deploy’ makes the configuration pushed to the device] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!clear-mac-address-table

get_device_list(associated_wlc_ip=None, collection_interval=None, collection_status=None, device_support_level=None, error_code=None, error_description=None, family=None, hostname=None, id=None, license_name=None, license_status=None, license_type=None, limit=None, location=None, location_name=None, mac_address=None, management_ip_address=None, module_equpimenttype=None, module_name=None, module_operationstatecode=None, module_partnumber=None, module_servicestate=None, module_vendorequipmenttype=None, not_synced_for_minutes=None, offset=None, platform_id=None, reachability_status=None, role=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, headers=None, **request_parameters)[source]

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search. For example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request: GET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..* If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. You can also specify offset & limit to get the required list. .

Parameters:
  • hostname (basestring, list, set, tuple) – hostname query parameter.

  • management_ip_address (basestring, list, set, tuple) – managementIpAddress query parameter.

  • mac_address (basestring, list, set, tuple) – macAddress query parameter.

  • location_name (basestring, list, set, tuple) – locationName query parameter.

  • serial_number (basestring, list, set, tuple) – serialNumber query parameter.

  • location (basestring, list, set, tuple) – location query parameter.

  • family (basestring, list, set, tuple) – family query parameter.

  • type (basestring, list, set, tuple) – type query parameter.

  • series (basestring, list, set, tuple) – series query parameter.

  • collection_status (basestring, list, set, tuple) – collectionStatus query parameter.

  • collection_interval (basestring, list, set, tuple) – collectionInterval query parameter.

  • not_synced_for_minutes (basestring, list, set, tuple) – notSyncedForMinutes query parameter.

  • error_code (basestring, list, set, tuple) – errorCode query parameter.

  • error_description (basestring, list, set, tuple) – errorDescription query parameter.

  • software_version (basestring, list, set, tuple) – softwareVersion query parameter.

  • software_type (basestring, list, set, tuple) – softwareType query parameter.

  • platform_id (basestring, list, set, tuple) – platformId query parameter.

  • role (basestring, list, set, tuple) – role query parameter.

  • reachability_status (basestring, list, set, tuple) – reachabilityStatus query parameter.

  • up_time (basestring, list, set, tuple) – upTime query parameter.

  • associated_wlc_ip (basestring, list, set, tuple) – associatedWlcIp query parameter.

  • license_name (basestring, list, set, tuple) – license.name query parameter.

  • license_type (basestring, list, set, tuple) – license.type query parameter.

  • license_status (basestring, list, set, tuple) – license.status query parameter.

  • module_name (basestring, list, set, tuple) – module+name query parameter.

  • module_equpimenttype (basestring, list, set, tuple) – module+equpimenttype query parameter.

  • module_servicestate (basestring, list, set, tuple) – module+servicestate query parameter.

  • module_vendorequipmenttype (basestring, list, set, tuple) – module+vendorequipmenttype query parameter.

  • module_partnumber (basestring, list, set, tuple) – module+partnumber query parameter.

  • module_operationstatecode (basestring, list, set, tuple) – module+operationstatecode query parameter.

  • id (basestring) – id query parameter. Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. .

  • device_support_level (basestring) – deviceSupportLevel query parameter.

  • offset (int) – offset query parameter. offset >= 1 [X gives results from Xth device onwards] .

  • limit (int) – limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-list

add_device(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds the device with given credential .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-device

sync_devices(cliTransport=None, computeDevice=None, enablePassword=None, extendedDiscoveryInfo=None, httpPassword=None, httpPort=None, httpSecure=None, httpUserName=None, ipAddress=None, merakiOrgId=None, netconfPort=None, password=None, serialNumber=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpRWCommunity=None, snmpRetry=None, snmpTimeout=None, snmpUserName=None, snmpVersion=None, type=None, updateMgmtIPaddressList=None, userName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Sync the devices provided as input .

Parameters:
  • cliTransport (string) – Devices’s cliTransport.

  • computeDevice (boolean) – Devices’s computeDevice.

  • enablePassword (string) – Devices’s enablePassword.

  • extendedDiscoveryInfo (string) – Devices’s extendedDiscoveryInfo.

  • httpPassword (string) – Devices’s httpPassword.

  • httpPort (string) – Devices’s httpPort.

  • httpSecure (boolean) – Devices’s httpSecure.

  • httpUserName (string) – Devices’s httpUserName.

  • ipAddress (list) – Devices’s ipAddress (list of strings).

  • merakiOrgId (list) – Devices’s merakiOrgId (list of strings).

  • netconfPort (string) – Devices’s netconfPort.

  • password (string) – Devices’s password.

  • serialNumber (string) – Devices’s serialNumber.

  • snmpAuthPassphrase (string) – Devices’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Devices’s snmpAuthProtocol.

  • snmpMode (string) – Devices’s snmpMode.

  • snmpPrivPassphrase (string) – Devices’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Devices’s snmpPrivProtocol.

  • snmpROCommunity (string) – Devices’s snmpROCommunity.

  • snmpRWCommunity (string) – Devices’s snmpRWCommunity.

  • snmpRetry (integer) – Devices’s snmpRetry.

  • snmpTimeout (integer) – Devices’s snmpTimeout.

  • snmpUserName (string) – Devices’s snmpUserName.

  • snmpVersion (string) – Devices’s snmpVersion.

  • type (string) – Devices’s type. Available values are ‘COMPUTE_DEVICE’, ‘MERAKI_DASHBOARD’, ‘NETWORK_DEVICE’ and ‘NODATACHANGE’.

  • updateMgmtIPaddressList (list) – Devices’s updateMgmtIPaddressList (list of objects).

  • userName (string) – Devices’s userName.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-devices

get_device_values_that_match_fully_or_partially_an_attribute(associated_wlc_ip=None, collection_interval=None, collection_status=None, error_code=None, family=None, hostname=None, limit=None, mac_address=None, management_ip_address=None, offset=None, platform_id=None, reachability_failure_reason=None, reachability_status=None, role=None, role_source=None, serial_number=None, series=None, software_type=None, software_version=None, type=None, up_time=None, vrf_name=None, headers=None, **request_parameters)[source]

Returns the list of values of the first given required parameter. You can use the .* in any value to conduct a wildcard search. For example, to get all the devices with the management IP address starting with 10.10. , issue the following request: GET /dna/inten/api/v1/network- device/autocomplete?managementIpAddress=10.10..* It will return the device management IP addresses that match fully or partially the provided attribute. {[10.10.1.1, 10.10.20.2, …]}. .

Parameters:
  • vrf_name (basestring) – vrfName query parameter.

  • management_ip_address (basestring) – managementIpAddress query parameter.

  • hostname (basestring) – hostname query parameter.

  • mac_address (basestring) – macAddress query parameter.

  • family (basestring) – family query parameter.

  • collection_status (basestring) – collectionStatus query parameter.

  • collection_interval (basestring) – collectionInterval query parameter.

  • software_version (basestring) – softwareVersion query parameter.

  • software_type (basestring) – softwareType query parameter.

  • reachability_status (basestring) – reachabilityStatus query parameter.

  • reachability_failure_reason (basestring) – reachabilityFailureReason query parameter.

  • error_code (basestring) – errorCode query parameter.

  • platform_id (basestring) – platformId query parameter.

  • series (basestring) – series query parameter.

  • type (basestring) – type query parameter.

  • serial_number (basestring) – serialNumber query parameter.

  • up_time (basestring) – upTime query parameter.

  • role (basestring) – role query parameter.

  • role_source (basestring) – roleSource query parameter.

  • associated_wlc_ip (basestring) – associatedWlcIp query parameter.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-values-that-match-fully-or-partially-an-attribute

update_device_role(id=None, role=None, roleSource=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the role of the device as access, core, distribution, border router .

Parameters:
  • id (string) – Devices’s id.

  • role (string) – Devices’s role.

  • roleSource (string) – Devices’s roleSource.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device-role

get_polling_interval_for_all_devices(headers=None, **request_parameters)[source]

Returns polling interval of all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-polling-interval-for-all-devices

get_device_config_for_all_devices(headers=None, **request_parameters)[source]

Returns the config for all devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-for-all-devices

get_device_config_count(headers=None, **request_parameters)[source]

Returns the count of device configs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-count

get_device_count(headers=None, **request_parameters)[source]

Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-count

export_device_list(deviceUuids=None, id=None, operationEnum=None, parameters=None, password=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Exports the selected network device to a file .

Parameters:
  • deviceUuids (list) – Devices’s deviceUuids (list of strings).

  • id (string) – Devices’s id.

  • operationEnum (string) – Devices’s operationEnum. Available values are ‘CREDENTIALDETAILS’ and ‘DEVICEDETAILS’.

  • parameters (list) – Devices’s parameters (list of strings).

  • password (string) – Devices’s password.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!export-device-list

get_functional_capability_for_devices(device_id, function_name=None, headers=None, **request_parameters)[source]

Returns the functional-capability for given devices .

Parameters:
  • device_id (basestring) – deviceId query parameter. Accepts comma separated deviceid’s and return list of functional-capabilities for the given id’s. If invalid or not-found id’s are provided, null entry will be returned in the list. .

  • function_name (basestring, list, set, tuple) – functionName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-functional-capability-for-devices

get_functional_capability_by_id(id, headers=None, **request_parameters)[source]

Returns functional capability with given Id .

Parameters:
  • id (basestring) – id path parameter. Functional Capability UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-functional-capability-by-id

Find all devices with link mismatch (speed / vlan) .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (int) – offset query parameter. Row Number. Default value is 1 .

  • limit (int) – limit query parameter. Default value is 500 .

  • category (basestring) – category query parameter. Links mismatch category. Value can be speed-duplex or vlan. .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter. Order. Value can be asc or desc. Default value is asc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!inventory-insight-device-link-mismatch

get_devices_with_snmpv3_des(site_id, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns devices added to Cisco DNA center with snmp v3 DES, where siteId is mandatory & accepts offset, limit, sortby, order which are optional. .

Parameters:
  • site_id (basestring) – siteId path parameter.

  • offset (int) – offset query parameter. Row Number. Default value is 1 .

  • limit (int) – limit query parameter. Default value is 500 .

  • sort_by (basestring) – sortBy query parameter. Sort By .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-with-snmpv3-des

get_network_device_by_ip(ip_address, headers=None, **request_parameters)[source]

Returns the network device by specified IP address .

Parameters:
  • ip_address (basestring) – ipAddress path parameter. Device IP address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-device-by-ip

get_modules(device_id, limit=None, name_list=None, offset=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns modules by specified device id .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-modules

get_module_count(device_id, name_list=None, operational_state_code_list=None, part_number_list=None, vendor_equipment_type_list=None, headers=None, **request_parameters)[source]

Returns Module Count .

Parameters:
  • device_id (basestring) – deviceId query parameter.

  • name_list (basestring, list, set, tuple) – nameList query parameter.

  • vendor_equipment_type_list (basestring, list, set, tuple) – vendorEquipmentTypeList query parameter.

  • part_number_list (basestring, list, set, tuple) – partNumberList query parameter.

  • operational_state_code_list (basestring, list, set, tuple) – operationalStateCodeList query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-module-count

get_module_info_by_id(id, headers=None, **request_parameters)[source]

Returns Module info by ‘module id’ .

Parameters:
  • id (basestring) – id path parameter. Module id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-module-info-by-id

get_device_by_serial_number(serial_number, headers=None, **request_parameters)[source]

Returns the network device if the given serial number matches with any of the serial numbers collected. .

Parameters:
  • serial_number (basestring) – serialNumber path parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-serial-number

sync_devices_using_forcesync(force_sync=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. Result can be seen in the child task of each device .

Parameters:
  • force_sync (bool) – forceSync query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sync-devices-using-forcesync

get_devices_registered_for_wsa_notification(macaddress=None, serial_number=None, headers=None, **request_parameters)[source]

It fetches devices which are registered to receive WSA notifications. The device serial number and/or MAC address are required to be provided as query parameters. .

Parameters:
  • serial_number (basestring) – serialNumber query parameter. Serial number of the device .

  • macaddress (basestring) – macaddress query parameter. Mac addres of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-registered-for-wsa-notification

get_all_user_defined_fields(id=None, name=None, headers=None, **request_parameters)[source]

Gets existing global User Defined Fields. If no input is given, it fetches ALL the Global UDFs. Filter/search is supported either by UDF Id(s) or by UDF name(s), but not both. .

Parameters:
  • id (basestring) – id query parameter. Comma-seperated id(s) used for search/filtering .

  • name (basestring) – name query parameter. Comma-seperated name(s) used for search/filtering .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-user-defined-fields

create_user_defined_field(description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates a new global User Defined Field, which can be assigned to devices .

Parameters:
  • description (string) – Devices’s Description of UDF .

  • name (string) – Devices’s Name of UDF .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-user-defined-field

update_user_defined_field(id, description=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates an existing global User Defined Field, using it’s id. .

Parameters:
  • description (string) – Devices’s Description of UDF .

  • name (string) – Devices’s Name of UDF .

  • id (basestring) – id path parameter. UDF id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-user-defined-field

delete_user_defined_field(id, headers=None, **request_parameters)[source]

Deletes an existing Global User-Defined-Field using it’s id. .

Parameters:
  • id (basestring) – id path parameter. UDF id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-user-defined-field

get_chassis_details_for_device(device_id, headers=None, **request_parameters)[source]

Returns chassis details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-chassis-details-for-device

get_stack_details_for_device(device_id, headers=None, **request_parameters)[source]

Retrieves complete stack details for given device ID .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-stack-details-for-device

remove_user_defined_field_from_device(device_id, name, headers=None, **request_parameters)[source]

Remove a User-Defined-Field from device. Name of UDF has to be passed as the query parameter. Please note that Global UDF will not be deleted by this operation. .

Parameters:
  • device_id (basestring) – deviceId path parameter. UUID of device from which UDF has to be removed .

  • name (basestring) – name query parameter. Name of UDF to be removed .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-user-defined-field-from-device

add_user_defined_field_to_device(device_id, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns an existing Global User-Defined-Field to a device. If the UDF is already assigned to the specific device, then it updates the device UDF value accordingly. Please note that the assigning UDF ‘name’ must be an existing global UDF. Otherwise error shall be shown. .

Parameters:
  • device_id (basestring) – deviceId path parameter. UUID of device to which UDF has to be added .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-user-defined-field-to-device

return_power_supply_fan_details_for_the_given_device(device_uuid, type=None, headers=None, **request_parameters)[source]

Return PowerSupply/ Fan details for the Given device .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter.

  • type (basestring) – type query parameter. Type value can be PowerSupply, Fan, Chassis, Backplane, Module, PROCESSOR, Other, SFP. If no type is mentioned, All equipments are fetched for the device. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!return-power-supply-fan-details-for-the-given-device

poe_interface_details(device_uuid, interface_name_list=None, headers=None, **request_parameters)[source]

Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names which is optional and returns information for that particular interfaces where(operStatus = operationalStatus) .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • interface_name_list (basestring) – interfaceNameList query parameter. comma seperated interface names .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!poe-interface-details

get_connected_device_detail(device_uuid, interface_uuid, headers=None, **request_parameters)[source]

Get connected device detail for given deviceUuid and interfaceUuid .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of Device .

  • interface_uuid (basestring) – interfaceUuid path parameter. instanceuuid of interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-connected-device-detail

get_linecard_details(device_uuid, headers=None, **request_parameters)[source]

Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-linecard-details

poe_details_(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Args:

device_uuid(basestring): deviceUuid path parameter. uuid of the device . headers(dict): Dictionary of HTTP Headers to send with the Request

.

**request_parameters: Additional request parameters (provides

support for parameters that may be added in the future).

Returns:

MyDict: JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Raises:

TypeError: If the parameter types are incorrect. MalformedRequest: If the request body created is invalid. ApiError: If the DNA Center cloud returns an error.

//{‘summary’: ‘POE details - 8ba6-7932-4ed9-abae’, ‘operationId’: ‘POEDetails’, ‘tags’: [‘Devices’], ‘description’: ‘Returns POE details for device.

‘, ‘parameters’: [{‘name’: ‘deviceUuid’, ‘in’: ‘path’, ‘description’: ‘uuid of the device ‘, ‘required’: True, ‘schema’: {‘type’: ‘string’}}], ‘responses’: [{‘code’: ‘200’, ‘content_type’: ‘application/json’, ‘schema’: ‘#/components/schemas/POEDetailsResponse’, ‘data’: {‘title’: ‘POEDetailsResponse’, ‘type’: ‘object’, ‘properties’: {‘response’: {‘title’: ‘POEDetailsResponseResponse’, ‘type’: ‘object’, ‘properties’: {‘powerAllocated’: {‘type’: ‘string’, ‘description’: ‘Power Allocated’}, ‘powerConsumed’: {‘type’: ‘string’, ‘description’: ‘Power Consumed’}, ‘powerRemaining’: {‘type’: ‘string’, ‘description’: ‘Power Remaining’}}}, ‘version’: {‘type’: ‘string’, ‘description’: ‘Version’}}}}], ‘content_types’: [‘application/json’], ‘response_type’: {}, ‘method’: ‘GET’, ‘path’: ‘/dna/intent/api/v1/network-device/{deviceUuid}/poe’, ‘originalURL’: ‘/dna/intent/api/v1/network-device/{deviceUuid}/poe’, ‘headers’: {}, ‘path_params’: {‘deviceUuid’: {‘type’: ‘string’, ‘description’: ‘deviceUuid path parameter. uuid of the device ‘, ‘required’: True}}, ‘params’: {}, ‘response_json_schema’: {‘title’: ‘POEDetailsResponse’, ‘type’: ‘object’, ‘properties’: {‘response’: {‘title’: ‘POEDetailsResponseResponse’, ‘type’: ‘object’, ‘properties’: {‘powerAllocated’: {‘type’: ‘string’, ‘description’: ‘Power Allocated’}, ‘powerConsumed’: {‘type’: ‘string’, ‘description’: ‘Power Consumed’}, ‘powerRemaining’: {‘type’: ‘string’, ‘description’: ‘Power Remaining’}}}, ‘version’: {‘type’: ‘string’, ‘description’: ‘Version’}}, ‘$schema’: ‘http://json-schema.org/draft-04/schema#’}, ‘response’: {‘response’: {‘powerAllocated’: ‘string’, ‘powerConsumed’: ‘string’, ‘powerRemaining’: ‘string’}, ‘version’: ‘string’}, ‘data’: {}, ‘id’: ‘f7a67aba-0b36-5a1e-9dae-62d148511a25’, ‘name’: ‘POEDetails’, ‘kwargs’: ‘’}

poe_details(device_uuid, headers=None, **request_parameters)[source]

Returns POE details for device. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. uuid of the device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!poe-details

get_supervisor_card_detail(device_uuid, headers=None, **request_parameters)[source]

Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. .

Parameters:
  • device_uuid (basestring) – deviceUuid path parameter. instanceuuid of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-supervisor-card-detail

get_device_by_id(id, headers=None, **request_parameters)[source]

Returns the network device details for the given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-by-id

delete_device_by_id(id, clean_config=None, headers=None, **request_parameters)[source]

Deletes the network device for the given Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • clean_config (bool) – cleanConfig query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-by-id

get_device_summary(id, headers=None, **request_parameters)[source]

Returns brief summary of device info such as hostname, management IP address for the given device Id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-summary

get_polling_interval_by_id(id, headers=None, **request_parameters)[source]

Returns polling interval by device id .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-polling-interval-by-id

get_organization_list_for_meraki(id, headers=None, **request_parameters)[source]

Returns list of organizations for meraki dashboard .

Parameters:
  • id (basestring) – id path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-organization-list-for-meraki

get_device_interface_vlans(id, interface_type=None, headers=None, **request_parameters)[source]

Returns Device Interface VLANs .

Parameters:
  • id (basestring) – id path parameter.

  • interface_type (basestring) – interfaceType query parameter. Vlan assocaited with sub-interface .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-interface-vlans

get_wireless_lan_controller_details_by_id(id, headers=None, **request_parameters)[source]

Returns the wireless lan controller info with given device ID .

Parameters:
  • id (basestring) – id path parameter. Device ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-wireless-lan-controller-details-by-id

get_device_config_by_id(network_device_id, headers=None, **request_parameters)[source]

Returns the device config by specified device ID .

Parameters:
  • network_device_id (basestring) – networkDeviceId path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-config-by-id

get_network_device_by_pagination_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the list of network devices for the given pagination range. The maximum number of records that can be retrieved is 500 .

Parameters:
  • start_index (int) – startIndex path parameter. Start index [>=1] .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return [1<= recordsToReturn <= 500] .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-device-by-pagination-range

discovery

class Discovery[source]

Cisco DNA Center Discovery API (version: 2.3.5.3).

Wraps the DNA Center Discovery API and exposes the API as native Python methods that return native Python objects.

delete_all_discovery(headers=None, **request_parameters)[source]

Stops all the discoveries and removes them .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-all-discovery

updates_discovery_by_id(attributeInfo=None, cdpLevel=None, deviceIds=None, discoveryCondition=None, discoveryStatus=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, id=None, ipAddressList=None, ipFilterList=None, isAutoCdp=None, lldpLevel=None, name=None, netconfPort=None, numDevices=None, parentDiscoveryId=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retryCount=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpRoCommunity=None, snmpRoCommunityDesc=None, snmpRwCommunity=None, snmpRwCommunityDesc=None, snmpUserName=None, timeOut=None, updateMgmtIp=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Stops or starts an existing discovery .

Parameters:
  • attributeInfo (object) – Discovery’s attributeInfo.

  • cdpLevel (integer) – Discovery’s cdpLevel.

  • deviceIds (string) – Discovery’s deviceIds.

  • discoveryCondition (string) – Discovery’s discoveryCondition.

  • discoveryStatus (string) – Discovery’s discoveryStatus.

  • discoveryType (string) – Discovery’s discoveryType.

  • enablePasswordList (string) – Discovery’s enablePasswordList.

  • globalCredentialIdList (list) – Discovery’s globalCredentialIdList (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • id (string) – Discovery’s id.

  • ipAddressList (string) – Discovery’s ipAddressList.

  • ipFilterList (string) – Discovery’s ipFilterList.

  • isAutoCdp (boolean) – Discovery’s isAutoCdp.

  • lldpLevel (integer) – Discovery’s lldpLevel.

  • name (string) – Discovery’s name.

  • netconfPort (string) – Discovery’s netconfPort.

  • numDevices (integer) – Discovery’s numDevices.

  • parentDiscoveryId (string) – Discovery’s parentDiscoveryId.

  • passwordList (string) – Discovery’s passwordList.

  • preferredMgmtIPMethod (string) – Discovery’s preferredMgmtIPMethod.

  • protocolOrder (string) – Discovery’s protocolOrder.

  • retryCount (integer) – Discovery’s retryCount.

  • snmpAuthPassphrase (string) – Discovery’s snmpAuthPassphrase.

  • snmpAuthProtocol (string) – Discovery’s snmpAuthProtocol.

  • snmpMode (string) – Discovery’s snmpMode.

  • snmpPrivPassphrase (string) – Discovery’s snmpPrivPassphrase.

  • snmpPrivProtocol (string) – Discovery’s snmpPrivProtocol.

  • snmpRoCommunity (string) – Discovery’s snmpRoCommunity.

  • snmpRoCommunityDesc (string) – Discovery’s snmpRoCommunityDesc.

  • snmpRwCommunity (string) – Discovery’s snmpRwCommunity.

  • snmpRwCommunityDesc (string) – Discovery’s snmpRwCommunityDesc.

  • snmpUserName (string) – Discovery’s snmpUserName.

  • timeOut (integer) – Discovery’s timeOut.

  • updateMgmtIp (boolean) – Discovery’s updateMgmtIp.

  • userNameList (string) – Discovery’s userNameList.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!updates-discovery-by-id

start_discovery(cdpLevel=None, discoveryType=None, enablePasswordList=None, globalCredentialIdList=None, httpReadCredential=None, httpWriteCredential=None, ipAddressList=None, ipFilterList=None, lldpLevel=None, name=None, netconfPort=None, passwordList=None, preferredMgmtIPMethod=None, protocolOrder=None, retry=None, snmpAuthPassphrase=None, snmpAuthProtocol=None, snmpMode=None, snmpPrivPassphrase=None, snmpPrivProtocol=None, snmpROCommunity=None, snmpROCommunityDesc=None, snmpRWCommunity=None, snmpRWCommunityDesc=None, snmpUserName=None, snmpVersion=None, timeout=None, userNameList=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates discovery with the given parameters .

Parameters:
  • cdpLevel (integer) – Discovery’s CDP level to which neighbor devices to be discovered .

  • discoveryType (string) – Discovery’s Type of Discovery. ‘SINGLE’, ‘RANGE’, ‘MULTI RANGE’, ‘CDP’, ‘LLDP’, ‘CIDR’ .

  • enablePasswordList (list) – Discovery’s Enable Password of the devices to be discovered (list of strings).

  • globalCredentialIdList (list) – Discovery’s Global Credential Ids to be used for discovery (list of strings).

  • httpReadCredential (object) – Discovery’s httpReadCredential.

  • httpWriteCredential (object) – Discovery’s httpWriteCredential.

  • ipAddressList (string) – Discovery’s IP Address of devices to be discovered. Ex: ‘172.30.0.1’ for SINGLE, CDP and LLDP; ‘72.30.0.1-172.30.0.4’ for RANGE; ‘72.30.0.1-172.30.0.4,172.31.0.1-172.31.0.4’ for MULTI RANGE; ‘172.30.0.1/20’ for CIDR .

  • ipFilterList (list) – Discovery’s IP Addresses of the devices to be filtered out during discovery (list of strings).

  • lldpLevel (integer) – Discovery’s LLDP level to which neighbor devices to be discovered .

  • name (string) – Discovery’s Name of the discovery .

  • netconfPort (string) – Discovery’s Netconf Port. It will need valid SSH credentials to work .

  • passwordList (list) – Discovery’s Password of the devices to be discovered (list of strings).

  • preferredMgmtIPMethod (string) – Discovery’s Preferred Management IP Method.’None’ or ‘UseLoopBack’. Default is ‘None’ .

  • protocolOrder (string) – Discovery’s Order of protocol (ssh/telnet) in which device connection will be tried. Ex: ‘telnet’: only telnet; ‘ssh,telnet’: ssh with higher order than telnet .

  • retry (integer) – Discovery’s Number of times to try establishing connection to device .

  • snmpAuthPassphrase (string) – Discovery’s Auth Pass phrase for SNMP .

  • snmpAuthProtocol (string) – Discovery’s SNMP auth protocol. SHA’ or ‘MD5’ .

  • snmpMode (string) – Discovery’s Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’ .

  • snmpPrivPassphrase (string) – Discovery’s Pass phrase for SNMP privacy .

  • snmpPrivProtocol (string) – Discovery’s SNMP privacy protocol. ‘DES’ or ‘AES128’ .

  • snmpROCommunity (string) – Discovery’s Snmp RO community of the devices to be discovered .

  • snmpROCommunityDesc (string) – Discovery’s Description for Snmp RO community .

  • snmpRWCommunity (string) – Discovery’s Snmp RW community of the devices to be discovered .

  • snmpRWCommunityDesc (string) – Discovery’s Description for Snmp RW community .

  • snmpUserName (string) – Discovery’s SNMP username of the device .

  • snmpVersion (string) – Discovery’s Version of SNMP. v2 or v3 .

  • timeout (integer) – Discovery’s Time to wait for device response in seconds .

  • userNameList (list) – Discovery’s Username of the devices to be discovered (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!start-discovery

get_count_of_all_discovery_jobs(headers=None, **request_parameters)[source]

Returns the count of all available discovery jobs .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-count-of-all-discovery-jobs

get_discovery_jobs_by_ip(ip_address, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given IP .

Parameters:
  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • name (basestring) – name query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovery-jobs-by-ip

delete_discovery_by_id(id, headers=None, **request_parameters)[source]

Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-discovery-by-id

get_discovery_by_id(id, headers=None, **request_parameters)[source]

Returns discovery by Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovery-by-id

get_list_of_discoveries_by_discovery_id(id, ip_address=None, limit=None, offset=None, headers=None, **request_parameters)[source]

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • ip_address (basestring) – ipAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-discoveries-by-discovery-id

get_discovered_network_devices_by_discovery_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovered-network-devices-by-discovery-id

get_devices_discovered_by_id(id, task_id=None, headers=None, **request_parameters)[source]

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-discovered-by-id

get_discovered_devices_by_range(id, records_to_return, start_index, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • task_id (basestring) – taskId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discovered-devices-by-range

get_network_devices_from_discovery(id, clistatus=None, http_status=None, ip_address=None, netconf_status=None, ping_status=None, snmp_status=None, sort_by=None, sort_order=None, task_id=None, headers=None, **request_parameters)[source]

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the “Get Discoveries by range” API. .

Parameters:
  • id (basestring) – id path parameter. Discovery ID .

  • task_id (basestring) – taskId query parameter.

  • sort_by (basestring) – sortBy query parameter.

  • sort_order (basestring) – sortOrder query parameter.

  • ip_address (basestring, list, set, tuple) – ipAddress query parameter.

  • ping_status (basestring, list, set, tuple) – pingStatus query parameter.

  • snmp_status (basestring, list, set, tuple) – snmpStatus query parameter.

  • clistatus (basestring, list, set, tuple) – cliStatus query parameter.

  • netconf_status (basestring, list, set, tuple) – netconfStatus query parameter.

  • http_status (basestring, list, set, tuple) – httpStatus query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-devices-from-discovery

delete_discovery_by_specified_range(records_to_delete, start_index, headers=None, **request_parameters)[source]

Stops discovery for the given range and removes them .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_delete (int) – recordsToDelete path parameter. Number of records to delete .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-discovery-by-specified-range

get_discoveries_by_range(records_to_return, start_index, headers=None, **request_parameters)[source]

Returns the discovery by specified range .

Parameters:
  • start_index (int) – startIndex path parameter. Start index .

  • records_to_return (int) – recordsToReturn path parameter. Number of records to return .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-discoveries-by-range

get_global_credentials(credential_sub_type, order=None, sort_by=None, headers=None, **request_parameters)[source]

Returns global credential for the given credential sub type .

Parameters:
  • credential_sub_type (basestring) – credentialSubType query parameter. Credential type as CLI / SNMPV2_READ_COMMUNITY / SNMPV2_WRITE_COMMUNITY / SNMPV3 / HTTP_WRITE / HTTP_READ / NETCONF .

  • sort_by (basestring) – sortBy query parameter.

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-global-credentials

update_cli_credentials(comments=None, credentialType=None, description=None, enablePassword=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global CLI credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • enablePassword (string) – Discovery’s enablePassword.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-cli-credentials

create_cli_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global CLI credential .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-cli-credentials

create_http_read_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds HTTP read credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-http-read-credentials

update_http_read_credential(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP Read credential .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-http-read-credential

update_http_write_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, password=None, port=None, secure=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global HTTP write credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • password (string) – Discovery’s password.

  • port (integer) – Discovery’s port.

  • secure (boolean) – Discovery’s secure.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-http-write-credentials

create_http_write_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global HTTP write credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-http-write-credentials

update_netconf_credentials(comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, netconfPort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global netconf credentials .

Parameters:
  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • netconfPort (string) – Discovery’s netconfPort.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-netconf-credentials

create_netconf_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global netconf credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-netconf-credentials

update_snmp_read_community(comments=None, credentialType=None, description=None, instanceUuid=None, readCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP read community .

Parameters:
  • comments (string) – Discovery’s Comments to identify the credential .

  • credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s Name/Description of the credential .

  • instanceUuid (string) – Discovery’s instanceUuid.

  • readCommunity (string) – Discovery’s SNMP read community. NO!$DATA!$ for no value change .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmp-read-community

create_snmp_read_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP read community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmp-read-community

create_snmp_write_community(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMP write community .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmp-write-community

update_snmp_write_community(comments=None, credentialType=None, description=None, instanceUuid=None, writeCommunity=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMP write community .

Parameters:
  • comments (string) – Discovery’s Comments to identify the credential .

  • credentialType (string) – Discovery’s Credential type to identify the application that uses the credential . Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s Name/Description of the credential .

  • instanceUuid (string) – Discovery’s instanceUuid.

  • writeCommunity (string) – Discovery’s SNMP write community. NO!$DATA!$ for no value change .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmp-write-community

update_snmpv3_credentials(authPassword=None, authType=None, comments=None, credentialType=None, description=None, id=None, instanceTenantId=None, instanceUuid=None, privacyPassword=None, privacyType=None, snmpMode=None, username=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates global SNMPv3 credential .

Parameters:
  • authPassword (string) – Discovery’s authPassword.

  • authType (string) – Discovery’s authType. Available values are ‘SHA’ and ‘MD5’.

  • comments (string) – Discovery’s comments.

  • credentialType (string) – Discovery’s credentialType. Available values are ‘GLOBAL’ and ‘APP’.

  • description (string) – Discovery’s description.

  • id (string) – Discovery’s id.

  • instanceTenantId (string) – Discovery’s instanceTenantId.

  • instanceUuid (string) – Discovery’s instanceUuid.

  • privacyPassword (string) – Discovery’s privacyPassword.

  • privacyType (string) – Discovery’s privacyType. Available values are ‘DES’ and ‘AES128’.

  • snmpMode (string) – Discovery’s snmpMode. Available values are ‘AUTHPRIV’, ‘AUTHNOPRIV’ and ‘NOAUTHNOPRIV’.

  • username (string) – Discovery’s username.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-snmpv3-credentials

create_snmpv3_credentials(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds global SNMPv3 credentials .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-snmpv3-credentials

delete_global_credentials_by_id(global_credential_id, headers=None, **request_parameters)[source]

Deletes global credential for the given ID .

Parameters:
  • global_credential_id (basestring) – globalCredentialId path parameter. ID of global-credential .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-credentials-by-id

update_global_credentials(global_credential_id, siteUuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update global credential for network devices in site(s) .

Parameters:
  • siteUuids (list) – Discovery’s siteUuids (list of strings).

  • global_credential_id (basestring) – globalCredentialId path parameter. Global credential Uuid .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-credentials

get_credential_sub_type_by_credential_id(id, headers=None, **request_parameters)[source]

Returns the credential sub type for the given Id .

Parameters:
  • id (basestring) – id path parameter. Global Credential ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-credential-sub-type-by-credential-id

get_snmp_properties(headers=None, **request_parameters)[source]

Returns SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-snmp-properties

create_update_snmp_properties(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds SNMP properties .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-update-snmp-properties

update_global_credentials_v2(cliCredential=None, httpsRead=None, httpsWrite=None, snmpV2cRead=None, snmpV2cWrite=None, snmpV3=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials. Multiple credentials can be passed at once, but only a single credential of a given type can be passed at once. Please refer sample Request Body for more information. .

Parameters:
  • cliCredential (object) – Discovery’s cliCredential.

  • httpsRead (object) – Discovery’s httpsRead.

  • httpsWrite (object) – Discovery’s httpsWrite.

  • snmpV2cRead (object) – Discovery’s snmpV2cRead.

  • snmpV2cWrite (object) – Discovery’s snmpV2cWrite.

  • snmpV3 (object) – Discovery’s snmpV3.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-credentials-v2

create_global_credentials_v2(cliCredential=None, httpsRead=None, httpsWrite=None, snmpV2cRead=None, snmpV2cWrite=None, snmpV3=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create new global credentials. Multiple credentials of various types can be passed at once. Please refer sample Request Body for more information. .

Parameters:
  • cliCredential (list) – Discovery’s cliCredential (list of objects).

  • httpsRead (list) – Discovery’s httpsRead (list of objects).

  • httpsWrite (list) – Discovery’s httpsWrite (list of objects).

  • snmpV2cRead (list) – Discovery’s snmpV2cRead (list of objects).

  • snmpV2cWrite (list) – Discovery’s snmpV2cWrite (list of objects).

  • snmpV3 (list) – Discovery’s snmpV3 (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-global-credentials-v2

get_all_global_credentials_v2(headers=None, **request_parameters)[source]

API to get device credentials’ details. It fetches all global credentials of all types at once, without the need to pass any input parameters. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-global-credentials-v2

delete_global_credential_v2(id, headers=None, **request_parameters)[source]

Delete a global credential. Only ‘id’ of the credential has to be passed. .

Parameters:
  • id (basestring) – id path parameter. Global Credential id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-credential-v2

eo_x

event_management

class EventManagement[source]

Cisco DNA Center Event Management API (version: 2.3.5.3).

Wraps the DNA Center Event Management API and exposes the API as native Python methods that return native Python objects.

get_auditlog_parent_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Parent Audit Log Event instances from the Event-Hub .

Parameters:
  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-auditlog-parent-records

get_auditlog_summary(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_parent_only=None, is_system_events=None, name=None, parent_instance_id=None, severity=None, site_id=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Summary from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • is_parent_only (bool) – isParentOnly query parameter. Parameter to filter parent only audit-logs. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-auditlog-summary

get_auditlog_records(category=None, context=None, description=None, device_id=None, domain=None, end_time=None, event_hierarchy=None, event_id=None, instance_id=None, is_system_events=None, limit=None, name=None, offset=None, order=None, parent_instance_id=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, user_id=None, headers=None, **request_parameters)[source]

Get Audit Log Event instances from the Event-Hub .

Parameters:
  • parent_instance_id (basestring) – parentInstanceId query parameter. Parent Audit Log record’s instanceID. .

  • instance_id (basestring) – instanceId query parameter. InstanceID of the Audit Log. .

  • name (basestring) – name query parameter. Audit Log notification event name. .

  • event_id (basestring) – eventId query parameter. Audit Log notification’s event ID. .

  • category (basestring) – category query parameter. Audit Log notification’s event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION .

  • severity (basestring) – severity query parameter. Audit Log notification’s event severity. Supported values: 1, 2, 3, 4, 5. .

  • domain (basestring) – domain query parameter. Audit Log notification’s event domain. .

  • sub_domain (basestring) – subDomain query parameter. Audit Log notification’s event sub-domain. .

  • source (basestring) – source query parameter. Audit Log notification’s event source. .

  • user_id (basestring) – userId query parameter. Audit Log notification’s event userId. .

  • context (basestring) – context query parameter. Audit Log notification’s event correlationId. .

  • event_hierarchy (basestring) – eventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example: “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” Delimiter for hierarchy separation is “.”. .

  • site_id (basestring) – siteId query parameter. Audit Log notification’s siteId. .

  • device_id (basestring) – deviceId query parameter. Audit Log notification’s deviceId. .

  • is_system_events (bool) – isSystemEvents query parameter. Parameter to filter system generated audit-logs. .

  • description (basestring) – description query parameter. String full/partial search (Provided input string is case insensitively matched for records). .

  • offset (int) – offset query parameter. Position of a particular Audit Log record in the data. .

  • limit (int) – limit query parameter. Number of Audit Log records to be returned per page. .

  • start_time (int) – startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) .

  • end_time (int) – endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory) .

  • sort_by (basestring) – sortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .

  • order (basestring) – order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-auditlog-records

get_status_api_for_events(execution_id, headers=None, **request_parameters)[source]

Get the Status of events API calls with provided executionId as mandatory path parameter .

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-status-api-for-events

update_email_destination(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Email Destination .

Parameters:
  • emailConfigId (string) – Event Management’s Required only for update email configuration .

  • fromEmail (string) – Event Management’s From Email.

  • primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

  • secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

  • subject (string) – Event Management’s Subject.

  • toEmail (string) – Event Management’s To Email.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-email-destination

get_email_destination(headers=None, **request_parameters)[source]

Get Email Destination .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-destination

create_email_destination(emailConfigId=None, fromEmail=None, primarySMTPConfig=None, secondarySMTPConfig=None, subject=None, toEmail=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Email Destination .

Parameters:
  • emailConfigId (string) – Event Management’s Required only for update email configuration .

  • fromEmail (string) – Event Management’s From Email.

  • primarySMTPConfig (object) – Event Management’s primarySMTPConfig.

  • secondarySMTPConfig (object) – Event Management’s secondarySMTPConfig.

  • subject (string) – Event Management’s Subject.

  • toEmail (string) – Event Management’s To Email.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-email-destination

get_notifications(category=None, domain=None, end_time=None, event_ids=None, limit=None, namespace=None, offset=None, order=None, severity=None, site_id=None, sort_by=None, source=None, start_time=None, sub_domain=None, tags=None, type=None, headers=None, **request_parameters)[source]

Get the list of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • offset (int) – offset query parameter. Start Offset .

  • limit (int) – limit query parameter. # of records .

  • sort_by (basestring) – sortBy query parameter. Sort By column .

  • order (basestring) – order query parameter. Ascending/Descending order [asc/desc] .

  • tags (basestring) – tags query parameter.

  • namespace (basestring) – namespace query parameter.

  • site_id (basestring) – siteId query parameter. Site Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-notifications

count_of_notifications(category=None, domain=None, end_time=None, event_ids=None, severity=None, source=None, start_time=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Get the Count of Published Notifications .

Parameters:
  • event_ids (basestring) – eventIds query parameter. The registered EventId should be provided .

  • start_time (int) – startTime query parameter. Start Time in milliseconds .

  • end_time (int) – endTime query parameter. End Time in milliseconds .

  • category (basestring) – category query parameter.

  • type (basestring) – type query parameter.

  • severity (basestring) – severity query parameter.

  • domain (basestring) – domain query parameter.

  • sub_domain (basestring) – subDomain query parameter. Sub Domain .

  • source (basestring) – source query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-notifications

get_snmp_destination(config_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Get SNMP Destination .

Parameters:
  • config_id (basestring) – configId query parameter. List of SNMP configurations .

  • offset (int) – offset query parameter. The number of SNMP configuration’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of SNMP configuration’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-snmp-destination

get_event_subscriptions(event_ids=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of Subscriptions’s based on provided offset and limit (Deprecated) .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-event-subscriptions

delete_event_subscriptions(subscriptions, headers=None, **request_parameters)[source]

Delete EventSubscriptions .

Parameters:
  • subscriptions (basestring) – subscriptions query parameter. List of EventSubscriptionId’s for removal .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-event-subscriptions

update_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SubscriptionEndpoint to list of registered events(Deprecated) .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-event-subscriptions

create_event_subscriptions(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Subscribe SubscriptionEndpoint to list of registered events (Deprecated) .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-event-subscriptions

get_email_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • offset (int) – offset query parameter. The number of Email Subscription detail’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Email Subscription detail’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-subscription-details

get_rest_webhook_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • offset (int) – offset query parameter. The number of Rest/Webhook Subscription detail’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Rest/Webhook Subscription detail’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-rest-webhook-subscription-details

get_syslog_subscription_details(instance_id=None, limit=None, name=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of subscription details for specified connectorType .

Parameters:
  • name (basestring) – name query parameter. Name of the specific configuration .

  • instance_id (basestring) – instanceId query parameter. Instance Id of the specific configuration .

  • offset (int) – offset query parameter. The number of Syslog Subscription detail’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Syslog Subscription detail’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-subscription-details

count_of_event_subscriptions(event_ids, headers=None, **request_parameters)[source]

Returns the Count of EventSubscriptions .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-event-subscriptions

create_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Email Subscription Endpoint for list of registered events. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-email-event-subscription

update_email_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Email Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-email-event-subscription

get_email_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Gets the list of email Subscriptions’s based on provided query params .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • domain (basestring) – domain query parameter. List of email subscriptions related to the respective domain .

  • sub_domain (basestring) – subDomain query parameter. List of email subscriptions related to the respective sub-domain .

  • category (basestring) – category query parameter. List of email subscriptions related to the respective category .

  • type (basestring) – type query parameter. List of email subscriptions related to the respective type .

  • name (basestring) – name query parameter. List of email subscriptions related to the respective name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-email-event-subscriptions

create_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-rest-webhook-event-subscription

get_rest_webhook_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Gets the list of Rest/Webhook Subscriptions’s based on provided query params .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • domain (basestring) – domain query parameter. List of subscriptions related to the respective domain .

  • sub_domain (basestring) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

  • category (basestring) – category query parameter. List of subscriptions related to the respective category .

  • type (basestring) – type query parameter. List of subscriptions related to the respective type .

  • name (basestring) – name query parameter. List of subscriptions related to the respective name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-rest-webhook-event-subscriptions

update_rest_webhook_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Rest/Webhook Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-rest-webhook-event-subscription

update_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-syslog-event-subscription

create_syslog_event_subscription(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Syslog Subscription Endpoint for list of registered events .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-syslog-event-subscription

get_syslog_event_subscriptions(category=None, domain=None, event_ids=None, limit=None, name=None, offset=None, order=None, sort_by=None, sub_domain=None, type=None, headers=None, **request_parameters)[source]

Gets the list of Syslog Subscriptions’s based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) .

  • offset (int) – offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • domain (basestring) – domain query parameter. List of subscriptions related to the respective domain .

  • sub_domain (basestring) – subDomain query parameter. List of subscriptions related to the respective sub- domain .

  • category (basestring) – category query parameter. List of subscriptions related to the respective category .

  • type (basestring) – type query parameter. List of subscriptions related to the respective type .

  • name (basestring) – name query parameter. List of subscriptions related to the respective name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-event-subscriptions

update_syslog_destination(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update Syslog Destination .

Parameters:
  • configId (string) – Event Management’s Required only for update syslog configuration .

  • description (string) – Event Management’s Description.

  • host (string) – Event Management’s Host.

  • name (string) – Event Management’s Name.

  • port (string) – Event Management’s Port.

  • protocol (string) – Event Management’s Protocol. Available values are ‘UDP’ and ‘TCP’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-syslog-destination

get_syslog_destination(config_id=None, limit=None, name=None, offset=None, order=None, protocol=None, sort_by=None, headers=None, **request_parameters)[source]

Get Syslog Destination .

Parameters:
  • config_id (basestring) – configId query parameter. Config id of syslog server .

  • name (basestring) – name query parameter. Name of syslog server .

  • protocol (basestring) – protocol query parameter. Protocol of syslog server .

  • offset (int) – offset query parameter. The number of syslog configuration’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of syslog configuration’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-syslog-destination

create_syslog_destination(configId=None, description=None, host=None, name=None, port=None, protocol=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create Syslog Destination .

Parameters:
  • configId (string) – Event Management’s Required only for update syslog configuration .

  • description (string) – Event Management’s Description.

  • host (string) – Event Management’s Host.

  • name (string) – Event Management’s Name.

  • port (string) – Event Management’s Port.

  • protocol (string) – Event Management’s Protocol. Available values are ‘UDP’ and ‘TCP’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-syslog-destination

create_webhook_destination(description=None, headers=None, method=None, name=None, trustCert=None, url=None, webhookId=None, payload=None, active_validation=True, **request_parameters)[source]

Create Webhook Destination .

Parameters:
  • description (string) – Event Management’s Description.

  • headers (list) – Event Management’s headers (list of objects).

  • method (string) – Event Management’s Method. Available values are ‘POST’ and ‘PUT’.

  • name (string) – Event Management’s Name.

  • trustCert (boolean) – Event Management’s Trust Cert.

  • url (string) – Event Management’s Url.

  • webhookId (string) – Event Management’s Required only for update webhook configuration . .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-webhook-destination

update_webhook_destination(description=None, headers=None, method=None, name=None, trustCert=None, url=None, webhookId=None, payload=None, active_validation=True, **request_parameters)[source]

Update Webhook Destination .

Parameters:
  • description (string) – Event Management’s Description.

  • method (string) – Event Management’s Method. Available values are ‘POST’ and ‘PUT’.

  • name (string) – Event Management’s Name.

  • trustCert (boolean) – Event Management’s Trust Cert.

  • url (string) – Event Management’s Url.

  • webhookId (string) – Event Management’s Required only for update webhook configuration .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-webhook-destination

get_webhook_destination(limit=None, offset=None, order=None, sort_by=None, webhook_ids=None, headers=None, **request_parameters)[source]

Get Webhook Destination .

Parameters:
  • webhook_ids (basestring) – webhookIds query parameter. List of webhook configurations .

  • offset (int) – offset query parameter. The number of webhook configuration’s to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of webhook configuration’s to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-webhook-destination

get_events(tags, event_id=None, limit=None, offset=None, order=None, sort_by=None, headers=None, **request_parameters)[source]

Gets the list of registered Events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • offset (int) – offset query parameter. The number of Registries to offset in the resultset whose default value 0 .

  • limit (int) – limit query parameter. The number of Registries to limit in the resultset whose default value 10 .

  • sort_by (basestring) – sortBy query parameter. SortBy field name .

  • order (basestring) – order query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-events

count_of_events(tags, event_id=None, headers=None, **request_parameters)[source]

Get the count of registered events with provided eventIds or tags as mandatory .

Parameters:
  • event_id (basestring) – eventId query parameter. The registered EventId should be provided .

  • tags (basestring) – tags query parameter. The registered Tags should be provided .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!count-of-events

get_eventartifacts(event_ids=None, limit=None, offset=None, order=None, search=None, sort_by=None, tags=None, headers=None, **request_parameters)[source]

Gets the list of artifacts based on provided offset and limit .

Parameters:
  • event_ids (basestring) – eventIds query parameter. List of eventIds .

  • tags (basestring) – tags query parameter. Tags defined .

  • offset (int) – offset query parameter. Record start offset .

  • limit (int) – limit query parameter. # of records to return in result set .

  • sort_by (basestring) – sortBy query parameter. Sort by field .

  • order (basestring) – order query parameter. sorting order (asc/desc) .

  • search (basestring) – search query parameter. findd matches in name, description, eventId, type, category .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-eventartifacts

eventartifact_count(headers=None, **request_parameters)[source]

Get the count of registered event artifacts with provided eventIds or tags as mandatory .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!eventartifact-count

get_connector_types(headers=None, **request_parameters)[source]

Get the list of connector types .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-connector-types

fabric_wireless

class FabricWireless[source]

Cisco DNA Center Fabric Wireless API (version: 2.3.5.3).

Wraps the DNA Center Fabric Wireless API and exposes the API as native Python methods that return native Python objects.

add_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add SSID to IP Pool Mapping. .

Parameters:
  • scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

  • vlanName (string) – Fabric Wireless’s VLAN Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-ssid-to-ip-pool-mapping

update_ssid_to_ip_pool_mapping(scalableGroupName=None, siteNameHierarchy=None, ssidNames=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update SSID to IP Pool Mapping. .

Parameters:
  • scalableGroupName (string) – Fabric Wireless’s Scalable Group Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • ssidNames (list) – Fabric Wireless’s List of SSIDs (list of strings).

  • vlanName (string) – Fabric Wireless’s VLAN Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-ssid-to-ip-pool-mapping

get_ssid_to_ip_pool_mapping(site_name_hierarchy, vlan_name, headers=None, **request_parameters)[source]

Get SSID to IP Pool Mapping .

Parameters:
  • vlan_name (basestring) – vlanName query parameter. VLAN Name .

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Heirarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ssid-to-ip-pool-mapping

remove_w_l_c_from_fabric_domain(device_ipaddress, headers=None, **request_parameters)[source]

Remove WLC from Fabric Domain .

Parameters:
  • device_ipaddress (basestring) – deviceIPAddress query parameter. Device Management IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-w-l-c-from-fabric-domain

add_w_l_c_to_fabric_domain(deviceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add WLC to Fabric Domain .

Parameters:
  • deviceName (string) – Fabric Wireless’s EWLC Device Name .

  • siteNameHierarchy (string) – Fabric Wireless’s Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-w-l-c-to-fabric-domain

file

class File[source]

Cisco DNA Center File API (version: 2.3.5.3).

Wraps the DNA Center File API and exposes the API as native Python methods that return native Python objects.

get_list_of_available_namespaces(headers=None, **request_parameters)[source]

Returns list of available namespaces .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-available-namespaces

get_list_of_files(name_space, headers=None, **request_parameters)[source]

Returns list of files under a specific namespace .

Parameters:
  • name_space (basestring) – nameSpace path parameter. A listing of fileId’s .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-files

download_a_file_by_fileid(file_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Downloads a file specified by fileId .

Parameters:
  • file_id (basestring) – fileId path parameter. File Identification number .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!download-a-file-by-fileid

upload_file(multipart_fields, multipart_monitor_callback, name_space, headers=None, **request_parameters)[source]

Uploads a new file within a specific nameSpace .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • name_space (basestring) – nameSpace path parameter.

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!upload-file

health_and_performance

class HealthAndPerformance[source]

Cisco DNA Center Health and Performance API (version: 2.3.5.3).

Wraps the DNA Center Health and Performance API and exposes the API as native Python methods that return native Python objects.

system_health(domain=None, limit=None, offset=None, subdomain=None, summary=None, headers=None, **request_parameters)[source]

This API retrieves the latest system events .

Parameters:
  • summary (bool) – summary query parameter. Fetch the latest high severity event .

  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-health

system_health_count(domain=None, subdomain=None, headers=None, **request_parameters)[source]

This API gives the count of the latest system events .

Parameters:
  • domain (basestring) – domain query parameter. Fetch system events with this domain. Possible values of domain are listed here : /dna/platform/app/consumer-portal/developer-toolkit/events .

  • subdomain (basestring) – subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-health-count

system_performance(end_time=None, function=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API gives the aggregated performance indicators. The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Valid values: cpu,memory,network .

  • function (basestring) – function query parameter. Valid values: sum,average,max .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-performance

system_performance_historical(end_time=None, kpi=None, start_time=None, headers=None, **request_parameters)[source]

This API retrieves the historical performance indicators . The data can be retrieved for the last 3 months. .

Parameters:
  • kpi (basestring) – kpi query parameter. Fetch historical data for this kpi. Valid values: cpu,memory,network .

  • start_time (int) – startTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched .

  • end_time (int) – endTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!system-performance-historical

itsm

class Itsm[source]

Cisco DNA Center ITSM API (version: 2.3.5.3).

Wraps the DNA Center ITSM API and exposes the API as native Python methods that return native Python objects.

get_cmdb_sync_status(date=None, status=None, headers=None, **request_parameters)[source]

This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter “status”,”date”.The supported values for status field are “Success”,”Failed”,”Unknown” and date field should be in “YYYY-MM- DD” format. By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response. .

Parameters:
  • status (basestring) – status query parameter. Supported values are “Success”,”Failed” and “Unknown”. Providing other values will result in all the available sync job status. .

  • date (basestring) – date query parameter. Provide date in “YYYY-MM-DD” format .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-cmdb-sync-status

get_failed_itsm_events(instance_id=None, headers=None, **request_parameters)[source]

Used to retrieve the list of integration events that failed to create tickets in ITSM .

Parameters:
  • instance_id (basestring) – instanceId query parameter. Instance Id of the failed event as in the Runtime Dashboard .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-failed-itsm-events

retry_integration_events(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings: [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retry-integration-events

itsm_integration

class ItsmIntegration[source]

Cisco DNA Center ITSM Integration API (version: 2.3.5.3).

Wraps the DNA Center ITSM Integration API and exposes the API as native Python methods that return native Python objects.

create_itsm_integration_setting(data=None, description=None, dypName=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates ITSM Integration setting .

Parameters:
  • data (object) – ITSM Integration’s data.

  • description (string) – ITSM Integration’s Description of the setting instance .

  • dypName (string) – ITSM Integration’s It should be ServiceNowConnection .

  • name (string) – ITSM Integration’s Name of the setting instance .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-itsm-integration-setting

update_itsm_integration_setting(instance_id, data=None, description=None, dypName=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the ITSM Integration setting .

Parameters:
  • data (object) – ITSM Integration’s data.

  • description (string) – ITSM Integration’s Description of the setting instance .

  • dypName (string) – ITSM Integration’s It should be ServiceNowConnection .

  • name (string) – ITSM Integration’s Name of the setting instance .

  • instance_id (basestring) – instanceId path parameter. Instance Id of the Integration setting instance .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-itsm-integration-setting

get_itsm_integration_setting_by_id(instance_id, headers=None, **request_parameters)[source]

Fetches ITSM Integration setting by ID .

Parameters:
  • instance_id (basestring) – instanceId path parameter. Instance Id of the Integration setting instance .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-itsm-integration-setting-by-id

delete_itsm_integration_setting(instance_id, headers=None, **request_parameters)[source]

Deletes the ITSM Integration setting .

Parameters:
  • instance_id (basestring) – instanceId path parameter. Instance Id of the Integration setting instance .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-itsm-integration-setting

get_all_itsm_integration_settings(headers=None, **request_parameters)[source]

Fetches all ITSM Integration settings .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-itsm-integration-settings

issues

class Issues[source]

Cisco DNA Center Issues API (version: 2.3.5.3).

Wraps the DNA Center Issues API and exposes the API as native Python methods that return native Python objects.

execute_suggested_actions_commands(entity_type=None, entity_value=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

This API triggers the execution of the suggested actions for an issue, given the Issue Id. It will return an execution Id. At the completion of the execution, the output of the commands associated with the suggested actions will be provided Invoking this API would provide the execution id. Execute the ‘Get Business API Execution Details’ API with this execution id, to receive the suggested actions commands output. .

Parameters:
  • entity_type (string) – Issues’s Commands provided as part of the suggested actions for an issue can be executed based on issue id. The value here must be issue_id .

  • entity_value (string) – Issues’s Contains the actual value for the entity type that has been defined .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!execute-suggested-actions-commands

get_issue_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-issue-enrichment-details

issues(ai_driven=None, device_id=None, end_time=None, issue_status=None, mac_address=None, priority=None, site_id=None, start_time=None, headers=None, **request_parameters)[source]

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device’s MAC address. .

Parameters:
  • start_time (int) – startTime query parameter. Starting epoch time in milliseconds of query time window .

  • end_time (int) – endTime query parameter. Ending epoch time in milliseconds of query time window .

  • site_id (basestring) – siteId query parameter. Assurance UUID value of the site in the issue content .

  • device_id (basestring) – deviceId query parameter. Assurance UUID value of the device in the issue content .

  • mac_address (basestring) – macAddress query parameter. Client’s device MAC address of the issue (format xx:xx:xx:xx:xx:xx) .

  • priority (basestring) – priority query parameter. The issue’s priority value (One of P1, P2, P3, or P4)(Use only when macAddress and deviceId are not provided) .

  • ai_driven (basestring) – aiDriven query parameter. The issue’s AI driven value (Yes or No)(Use only when macAddress and deviceId are not provided) .

  • issue_status (basestring) – issueStatus query parameter. The issue’s status value (One of ACTIVE, IGNORED, RESOLVED) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!issues

lan_automation

class LanAutomation[source]

Cisco DNA Center LAN Automation API (version: 2.3.5.3).

Wraps the DNA Center LAN Automation API and exposes the API as native Python methods that return native Python objects.

lan_automation_start(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Invoke this API to start LAN Automation for the given site. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-start

start(headers=None, payload=None, active_validation=True, **query_parameters)[source]

Alias for lan_automation_start

lan_automation_session_count(headers=None, **request_parameters)[source]

Invoke this API to get the total count of LAN Automation sessions. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-session-count

session_count(headers=None, **query_parameters)[source]

Alias for lan_automation_session_count

lan_automation_log(limit=None, offset=None, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session logs. .

Parameters:
  • offset (int) – offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. .

  • limit (int) – limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-log

log(limit=None, offset=None, headers=None, **query_parameters)[source]

Alias for lan_automation_log

lan_automation_log_by_id(id, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session logs based on the given LAN Automation session id. .

Parameters:
  • id (basestring) – id path parameter. LAN Automation session identifier. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-log-by-id

log_by_id(id, headers=None, **query_parameters)[source]

Alias for lan_automation_log_by_id

lan_automation_logs_for_individual_devices(id, serial_number, log_level=None, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session logs for individual devices based on the given LAN Automation session id and device serial number. .

Parameters:
  • id (basestring) – id path parameter. LAN Automation session identifier. .

  • serial_number (basestring) – serialNumber path parameter. Device serial number. .

  • log_level (basestring) – logLevel query parameter. Supported levels are ERROR, INFO, WARNING, TRACE, CONFIG and ALL. Specifying ALL will display device specific logs with the exception of CONFIG logs. In order to view CONFIG logs along with the remaining logs, please leave the query parameter blank. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-logs-for-individual-devices

lan_automation_active_sessions(headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation active session information .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-active-sessions

lan_automation_status(limit=None, offset=None, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session status. .

Parameters:
  • offset (int) – offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. .

  • limit (int) – limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-status

status(limit=None, offset=None, headers=None, **query_parameters)[source]

Alias for lan_automation_status

lan_automation_status_by_id(id, headers=None, **request_parameters)[source]

Invoke this API to get the LAN Automation session status based on the given Lan Automation session id. .

Parameters:
  • id (basestring) – id path parameter. LAN Automation session identifier. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-status-by-id

status_by_id(id, headers=None, **query_parameters)[source]

Alias for lan_automation_status_by_id

lan_automation_stop(id, headers=None, **request_parameters)[source]

Invoke this API to stop LAN Automation for the given site. .

Parameters:
  • id (basestring) – id path parameter. LAN Automation id can be obtained from /dna/intent/api/v1/lan- automation/status. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!lan-automation-stop

stop(id, headers=None, **query_parameters)[source]

Alias for lan_automation_stop

licenses

class Licenses[source]

Cisco DNA Center Licenses API (version: 2.3.5.3).

Wraps the DNA Center Licenses API and exposes the API as native Python methods that return native Python objects.

device_count_details2(device_type=None, dna_level=None, registration_status=None, smart_account_id=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Get total number of managed device(s). .

Parameters:
  • device_type (basestring) – device_type query parameter. Type of device .

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA License Level .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Virtual account name .

  • smart_account_id (basestring) – smart_account_id query parameter. Smart account id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-count-details

device_count_details(device_type=None, dna_level=None, registration_status=None, smart_account_id=None, virtual_account_name=None, headers=None, **request_parameters)[source]
device_license_summary2(limit, order, page_number, device_type=None, device_uuid=None, dna_level=None, registration_status=None, smart_account_id=None, sort_by=None, virtual_account_name=None, headers=None, **request_parameters)[source]

Show license summary of device(s). .

Parameters:
  • page_number (int) – page_number query parameter. Page number of response .

  • order (basestring) – order query parameter. Sorting order .

  • sort_by (basestring) – sort_by query parameter. Sort result by field .

  • dna_level (basestring) – dna_level query parameter. Device Cisco DNA license level .

  • device_type (basestring) – device_type query parameter. Type of device .

  • limit (int) – limit query parameter.

  • registration_status (basestring) – registration_status query parameter. Smart license registration status of device .

  • virtual_account_name (basestring) – virtual_account_name query parameter. Name of virtual account .

  • smart_account_id (int) – smart_account_id query parameter. Id of smart account .

  • device_uuid (basestring) – device_uuid query parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-license-summary2

device_license_summary(limit, order, page_number, device_type=None, device_uuid=None, dna_level=None, registration_status=None, smart_account_id=None, sort_by=None, virtual_account_name=None, headers=None, **request_parameters)[source]
device_license_details2(device_uuid, headers=None, **request_parameters)[source]

Get detailed license information of a device. .

Parameters:
  • device_uuid (basestring) – device_uuid path parameter. Id of device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-license-details2

device_license_details(device_uuid, headers=None, **request_parameters)[source]
device_deregistration2(device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Deregister device(s) from CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-deregistration2

device_registration2(virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Register device(s) in CSSM(Cisco Smart Software Manager). .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!device-registration2

change_virtual_account2(smart_account_id, virtual_account_name, device_uuids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Transfer device(s) from one virtual account to another within same smart account. .

Parameters:
  • device_uuids (list) – Licenses’s Comma separated device ids (list of strings).

  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of target virtual account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!change-virtual-account2

virtual_account_details2(smart_account_id, headers=None, **request_parameters)[source]

Get virtual account details of a smart account. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!virtual-account-details2

smart_account_details(headers=None, **request_parameters)[source]

Get detail of all smart accounts. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!smart-account-details

license_term_details2(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get license term details. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license term detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!license-term-details2

license_usage_details2(device_type, smart_account_id, virtual_account_name, headers=None, **request_parameters)[source]

Get count of purchased and in use Cisco DNA and Network licenses. .

Parameters:
  • smart_account_id (basestring) – smart_account_id path parameter. Id of smart account .

  • virtual_account_name (basestring) – virtual_account_name path parameter. Name of virtual account. Putting “All” will give license term detail for all virtual accounts. .

  • device_type (basestring) – device_type query parameter. Type of device like router, switch, wireless or ise .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!license-usage-details2

network_settings

class NetworkSettings[source]

Cisco DNA Center Network Settings API (version: 2.3.5.3).

Wraps the DNA Center Network Settings API and exposes the API as native Python methods that return native Python objects.

assign_device_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assign Device Credential to a site. .

Parameters:
  • cliId (string) – Network Settings’s Cli Id.

  • httpRead (string) – Network Settings’s Http Read.

  • httpWrite (string) – Network Settings’s Http Write.

  • snmpV2ReadId (string) – Network Settings’s Snmp V2 Read Id.

  • snmpV2WriteId (string) – Network Settings’s Snmp V2 Write Id.

  • snmpV3Id (string) – Network Settings’s Snmp V3 Id.

  • site_id (basestring) – siteId path parameter. site id to assign credential. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!assign-device-credential-to-site

assign_credential_to_site(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]
create_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-device-credentials

update_device_credentials(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update device credentials. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-device-credentials

get_device_credential_details(site_id=None, headers=None, **request_parameters)[source]

API to get device credential details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve the credential details associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-credential-details

delete_device_credential(id, headers=None, **request_parameters)[source]

Delete device credential. .

Parameters:
  • id (basestring) – id path parameter. global credential id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-device-credential

get_global_pool(limit=None, offset=None, headers=None, **request_parameters)[source]

API to get global pool. .

Parameters:
  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-global-pool

update_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update global pool .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-global-pool

create_global_pool(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create global pool. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-global-pool

delete_global_ip_pool(id, headers=None, **request_parameters)[source]

API to delete global IP pool. .

Parameters:
  • id (basestring) – id path parameter. global pool id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-global-ip-pool

get_network(site_id=None, headers=None, **request_parameters)[source]

API to get DHCP and DNS center server details. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to get the network settings associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network

create_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create a network for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to which site details to associate with the network settings. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-network

update_network(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site id to update the network settings which is associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-network

get_reserve_ip_subpool(limit=None, offset=None, site_id=None, headers=None, **request_parameters)[source]

API to get the ip subpool info. .

Parameters:
  • site_id (basestring) – siteId query parameter. site id to get the reserve ip associated with the site .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. No of Global Pools to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-reserve-ip-subpool

release_reserve_ip_subpool(id, headers=None, **request_parameters)[source]

API to delete the reserved ip subpool .

Parameters:
  • id (basestring) – id path parameter. Id of reserve ip subpool to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!release-reserve-ip-subpool

reserve_ip_subpool(site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv4GlobalPool=None, ipv4Prefix=None, ipv4PrefixLength=None, ipv4Subnet=None, ipv4TotalHost=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to reserve an ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv4GateWay (string) – Network Settings’s Gateway ip address details, example: 175.175.0.1 .

  • ipv4GlobalPool (string) – Network Settings’s IP v4 Global pool address with cidr, example: 175.175.0.0/16 .

  • ipv4Prefix (boolean) – Network Settings’s IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable .

  • ipv4PrefixLength (integer) – Network Settings’s The ipv4 prefix length is required when ipv4prefix value is true. .

  • ipv4Subnet (string) – Network Settings’s IPv4 Subnet address, example: 175.175.0.0 .

  • ipv4TotalHost (integer) – Network Settings’s IPv4 total host is required when ipv4prefix value is false. .

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • type (string) – Network Settings’s Type of the reserve ip sub pool . Available values are ‘Generic’, ‘LAN’, ‘WAN’, ‘management’ and ‘service’.

  • site_id (basestring) – siteId path parameter. Site id to reserve the ip sub pool. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!reserve-ip-subpool

update_reserve_ip_subpool(id, site_id, ipv4DhcpServers=None, ipv4DnsServers=None, ipv4GateWay=None, ipv6AddressSpace=None, ipv6DhcpServers=None, ipv6DnsServers=None, ipv6GateWay=None, ipv6GlobalPool=None, ipv6Prefix=None, ipv6PrefixLength=None, ipv6Subnet=None, ipv6TotalHost=None, name=None, slaacSupport=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update ip subpool from the global pool .

Parameters:
  • ipv4DhcpServers (list) – Network Settings’s IPv4 input for dhcp server ip example: 1.1.1.1 (list of strings).

  • ipv4DnsServers (list) – Network Settings’s IPv4 input for dns server ip example: 4.4.4.4 (list of strings).

  • ipv4GateWay (string) – Network Settings’s Ipv4 Gate Way.

  • ipv6AddressSpace (boolean) – Network Settings’s If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required .

  • ipv6DhcpServers (list) – Network Settings’s IPv6 format dhcp server as input example : 2001:db8::1234 (list of strings).

  • ipv6DnsServers (list) – Network Settings’s IPv6 format dns server input example: 2001:db8::1234 (list of strings).

  • ipv6GateWay (string) – Network Settings’s Gateway ip address details, example: 2001:db8:85a3:0:100::1 .

  • ipv6GlobalPool (string) – Network Settings’s IP v6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example: 2001:db8:85a3::/64 .

  • ipv6Prefix (boolean) – Network Settings’s IPv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable .

  • ipv6PrefixLength (integer) – Network Settings’s IPv6 prefix length is required when the ipv6prefix value is true .

  • ipv6Subnet (string) – Network Settings’s IPv6 Subnet address, example :2001:db8:85a3:0:100:: .

  • ipv6TotalHost (integer) – Network Settings’s IPv6 total host is required when ipv6prefix value is false. .

  • name (string) – Network Settings’s Name of the reserve ip sub pool .

  • slaacSupport (boolean) – Network Settings’s Slaac Support.

  • site_id (basestring) – siteId path parameter. Site id of site to update sub pool. .

  • id (basestring) – id query parameter. Id of subpool to be associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-reserve-ip-subpool

get_service_provider_details(headers=None, **request_parameters)[source]

API to get service provider details (QoS). .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-service-provider-details

create_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create Service Provider Profile(QOS). .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-sp-profile

update_sp_profile(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update Service Provider Profile (QoS). .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-sp-profile

delete_sp_profile(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider Profile (QoS). .

Parameters:
  • sp_profile_name (basestring) – spProfileName path parameter. sp profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-sp-profile

assign_device_credential_to_site_v2(site_id, cliId=None, httpRead=None, httpWrite=None, snmpV2ReadId=None, snmpV2WriteId=None, snmpV3Id=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to assign Device Credential to a site. .

Parameters:
  • cliId (string) – Network Settings’s CLI Credential Id .

  • httpRead (string) – Network Settings’s HTTP(S) Read Credential Id .

  • httpWrite (string) – Network Settings’s HTTP(S) Write Credential Id .

  • snmpV2ReadId (string) – Network Settings’s SNMPv2c Read Credential Id .

  • snmpV2WriteId (string) – Network Settings’s SNMPv2c Write Credential Id .

  • snmpV3Id (string) – Network Settings’s SNMPv3 Credential Id .

  • site_id (basestring) – siteId path parameter. Site Id to assign credential. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!assign-device-credential-to-site-v2

get_network_v2(site_id=None, headers=None, **request_parameters)[source]

API to get SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings. .

Parameters:
  • site_id (basestring) – siteId query parameter. Site Id to get the network settings associated with the site. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-network-v2

create_network_v2(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site Id to which site details to associate with the network settings. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-network-v2

update_network_v2(site_id, settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings. .

Parameters:
  • settings (object) – Network Settings’s settings.

  • site_id (basestring) – siteId path parameter. Site Id to update the network settings which is associated with the site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-network-v2

create_sp_profile_v2(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create Service Provider Profile(QOS). .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-sp-profile-v2

update_sp_profile_v2(settings=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update Service Provider Profile (QoS). .

Parameters:
  • settings (object) – Network Settings’s settings.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-sp-profile-v2

get_service_provider_details_v2(headers=None, **request_parameters)[source]

API to get Service Provider details (QoS). .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-service-provider-details-v2

delete_sp_profile_v2(sp_profile_name, headers=None, **request_parameters)[source]

API to delete Service Provider Profile (QoS). .

Parameters:
  • sp_profile_name (basestring) – spProfileName path parameter. sp profile name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-sp-profile-v2

path_trace

class PathTrace[source]

Cisco DNA Center Path Trace API (version: 2.3.5.3).

Wraps the DNA Center Path Trace API and exposes the API as native Python methods that return native Python objects.

retrives_all_previous_pathtraces_summary(dest_ip=None, dest_port=None, gt_create_time=None, last_update_time=None, limit=None, lt_create_time=None, offset=None, order=None, periodic_refresh=None, protocol=None, sort_by=None, source_ip=None, source_port=None, status=None, task_id=None, headers=None, **request_parameters)[source]

Returns a summary of all flow analyses stored. Results can be filtered by specified parameters. .

Parameters:
  • periodic_refresh (bool) – periodicRefresh query parameter. Is analysis periodically refreshed? .

  • source_ip (basestring) – sourceIP query parameter. Source IP address .

  • dest_ip (basestring) – destIP query parameter. Destination IP adress .

  • source_port (basestring) – sourcePort query parameter. Source port .

  • dest_port (basestring) – destPort query parameter. Destination port .

  • gt_create_time (basestring) – gtCreateTime query parameter. Analyses requested after this time .

  • lt_create_time (basestring) – ltCreateTime query parameter. Analyses requested before this time .

  • protocol (basestring) – protocol query parameter.

  • status (basestring) – status query parameter.

  • task_id (basestring) – taskId query parameter. Task ID .

  • last_update_time (basestring) – lastUpdateTime query parameter. Last update time .

  • limit (int) – limit query parameter. Number of resources returned .

  • offset (int) – offset query parameter. Start index of resources returned (1-based) .

  • order (basestring) – order query parameter. Order by this field .

  • sort_by (basestring) – sortBy query parameter. Sort by this field .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrives-all-previous-pathtraces-summary

initiate_a_new_pathtrace(controlPath=None, destIP=None, destPort=None, inclusions=None, periodicRefresh=None, protocol=None, sourceIP=None, sourcePort=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress. .

Parameters:
  • controlPath (boolean) – Path Trace’s Control path tracing .

  • destIP (string) – Path Trace’s Destination IP address .

  • destPort (string) – Path Trace’s Destination Port .

  • inclusions (list) – Path Trace’s Subset of {INTERFACE-STATS, QOS-STATS, DEVICE-STATS, PERFORMANCE-STATS, ACL-TRACE} (list of strings).

  • periodicRefresh (boolean) – Path Trace’s Periodic refresh of path for every 30 sec .

  • protocol (string) – Path Trace’s Protocol .

  • sourceIP (string) – Path Trace’s Source IP address .

  • sourcePort (string) – Path Trace’s Source Port .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!initiate-a-new-pathtrace

retrieves_previous_pathtrace(flow_analysis_id, headers=None, **request_parameters)[source]

Returns result of a previously requested flow analysis by its Flow Analysis id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieves-previous-pathtrace

deletes_pathtrace_by_id(flow_analysis_id, headers=None, **request_parameters)[source]

Deletes a flow analysis request by its id .

Parameters:
  • flow_analysis_id (basestring) – flowAnalysisId path parameter. Flow analysis request id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deletes-pathtrace-by-id

platform

class Platform[source]

Cisco DNA Center Platform API (version: 2.3.5.3).

Wraps the DNA Center Platform API and exposes the API as native Python methods that return native Python objects.

cisco_dna_center_packages_summary(headers=None, **request_parameters)[source]

Provides information such as name, version of packages installed on the DNA center. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!cisco-dna-center-packages-summary

release_summary(headers=None, **request_parameters)[source]

Provides information such as API version, mandatory core packages for installation or upgrade, optional packages, Cisco DNA Center name and version, supported direct updates, and tenant ID. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!release-summary

nodes_configuration_summary(headers=None, **request_parameters)[source]

Provides details about the current Cisco DNA Center node configuration, such as API version, node name, NTP server, intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default gateway, and interface information. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!nodes-configuration-summary

reports

class Reports[source]

Cisco DNA Center Reports API (version: 2.3.5.3).

Wraps the DNA Center Reports API and exposes the API as native Python methods that return native Python objects.

create_or_schedule_a_report(deliveries=None, name=None, schedule=None, tags=None, view=None, viewGroupId=None, viewGroupVersion=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create/Schedule a report configuration. Use “Get view details for a given view group & view” API to get the metadata required to configure a report. .

Parameters:
  • deliveries (list) – Reports’s Array of available delivery channels (list of objects).

  • name (string) – Reports’s report name .

  • schedule (object) – Reports’s schedule.

  • tags (list) – Reports’s array of tags for report (list of strings).

  • view (object) – Reports’s view.

  • viewGroupId (string) – Reports’s viewGroupId of the viewgroup for the report .

  • viewGroupVersion (string) – Reports’s version of viewgroup for the report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-or-schedule-a-report

get_list_of_scheduled_reports(view_group_id=None, view_id=None, headers=None, **request_parameters)[source]

Get list of scheduled report configurations. .

Parameters:
  • view_group_id (basestring) – viewGroupId query parameter. viewGroupId of viewgroup for report .

  • view_id (basestring) – viewId query parameter. viewId of view for report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-list-of-scheduled-reports

get_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Get scheduled report configuration by reportId .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-a-scheduled-report

delete_a_scheduled_report(report_id, headers=None, **request_parameters)[source]

Delete a scheduled report configuration. Deletes the report executions also. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-a-scheduled-report

get_all_execution_details_for_a_given_report(report_id, headers=None, **request_parameters)[source]

Get details of all executions for a given report .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-execution-details-for-a-given-report

download_report_content(execution_id, report_id, dirpath=None, save_file=None, filename=None, headers=None, **request_parameters)[source]

Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header. .

Parameters:
  • report_id (basestring) – reportId path parameter. reportId of report .

  • execution_id (basestring) – executionId path parameter. executionId of report execution .

  • dirpath (basestring) – Directory absolute path. Defaults to os.getcwd().

  • save_file (bool) – Enable or disable automatic file creation of raw response.

  • filename (basestring) – The filename used to save the download file.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

The DownloadResponse wrapper. Wraps the urllib3.response.HTTPResponse. For more information check the urlib3 documentation

Return type:

DownloadResponse

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

  • DownloadFailure – If was not able to download the raw

  • response to a file.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!download-report-content

get_all_view_groups(headers=None, **request_parameters)[source]

Gives a list of summary of all view groups. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-all-view-groups

get_views_for_a_given_view_group(view_group_id, headers=None, **request_parameters)[source]

Gives a list of summary of all views in a viewgroup. Use “Get all view groups” API to get the viewGroupIds (required as a query param for this API) for available viewgroups. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-views-for-a-given-view-group

get_view_details_for_a_given_view_group_and_view(view_group_id, view_id, headers=None, **request_parameters)[source]

Gives complete information of the view that is required to configure a report. Use “Get views for a given view group” API to get the viewIds (required as a query param for this API) for available views. .

Parameters:
  • view_group_id (basestring) – viewGroupId path parameter. viewGroupId of viewgroup .

  • view_id (basestring) – viewId path parameter. view id of view .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-view-details-for-a-given-view-group-and-view

sda

class Sda[source]

Cisco DNA Center SDA API (version: 2.3.5.3).

Wraps the DNA Center SDA API and exposes the API as native Python methods that return native Python objects.

get_default_authentication_profile(site_name_hierarchy, authenticate_template_name=None, headers=None, **request_parameters)[source]

Get default authentication profile from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • authenticate_template_name (basestring) – authenticateTemplateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-default-authentication-profile

add_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add default authentication template in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-default-authentication-profile

update_default_authentication_profile(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update default authentication profile in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-default-authentication-profile

delete_default_authentication_profile(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete default authentication profile in SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-default-authentication-profile

adds_border_device(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add border device in SDA Fabric .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!adds-border-device

gets_border_device_detail(device_management_ip_address, headers=None, **request_parameters)[source]

Get border device detail from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!gets-border-device-detail

deletes_border_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete border device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!deletes-border-device

delete_control_plane_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete control plane device in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-control-plane-device

get_control_plane_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get control plane device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-control-plane-device

add_control_plane_device(deviceManagementIpAddress=None, routeDistributionProtocol=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add control plane device in SDA Fabric .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

  • routeDistributionProtocol (string) – SDA’s Route Distribution Protocol for Control Plane Device. Allowed values are “LISP_BGP” or “LISP_PUB_SUB”. Default value is “LISP_BGP” .

  • siteNameHierarchy (string) – SDA’s siteNameHierarchy of the Provisioned Device(site should be part of Fabric Site) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-control-plane-device

get_device_info(device_management_ip_address, headers=None, **request_parameters)[source]

Get device info from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-info

get_device_role_in_sda_fabric(device_management_ip_address, headers=None, **request_parameters)[source]

Get device role in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Device Management IP Address .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-role-in-sda-fabric

add_edge_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add edge device in SDA Fabric .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Device which is provisioned successfully .

  • siteNameHierarchy (string) – SDA’s siteNameHierarchy of the Provisioned Device(site should be part of Fabric Site) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-edge-device

delete_edge_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete edge device from SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-edge-device

get_edge_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get edge device from SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-edge-device

get_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Site info from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site

delete_site(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete Site from SDA Fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Site Name Hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-site

add_site(fabricName=None, fabricType=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Site in SDA Fabric .

Parameters:
  • fabricName (string) – SDA’s Warning Starting DNA Center 2.2.3.5 release, this field has been deprecated. SD-Access Fabric does not need it anymore. It will be removed in future DNA Center releases. .

  • fabricType (string) – SDA’s Type of SD-Access Fabric. Allowed values are “FABRIC_SITE” or “FABRIC_ZONE”. Default value is “FABRIC_SITE”. .

  • siteNameHierarchy (string) – SDA’s Existing site name hierarchy available at global level. For Example “Global/Chicago/Building21/Floor1” .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-site

add_port_assignment_for_access_point(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for access point in SDA Fabric .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated to Fabric Site . Available values are ‘No Authentication’, ‘Open Authentication’, ‘Closed Authentication ‘ and ‘Low Impact ‘.

  • dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to INFRA_VN .

  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the edge device .

  • interfaceDescription (string) – SDA’s Details or note of interface port assignment .

  • interfaceName (string) – SDA’s Interface Name of the edge device .

  • siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-port-assignment-for-access-point

delete_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for access point in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-port-assignment-for-access-point

get_port_assignment_for_access_point(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for access point in SDA Fabric .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-port-assignment-for-access-point

delete_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Delete Port assignment for user device in SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-port-assignment-for-user-device

add_port_assignment_for_user_device(authenticateTemplateName=None, dataIpAddressPoolName=None, deviceManagementIpAddress=None, interfaceDescription=None, interfaceName=None, interfaceNames=None, scalableGroupName=None, siteNameHierarchy=None, voiceIpAddressPoolName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Port assignment for user device in SDA Fabric. .

Parameters:
  • authenticateTemplateName (string) – SDA’s Authenticate TemplateName associated with siteNameHierarchy . Available values are ‘Open Authentication’, ‘Closed Authentication’, ‘Low Impact’ and ‘No Authentication’.

  • dataIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as DATA(can’t be empty if voiceIpAddressPoolName is empty) .

  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the Edge Node Device. .

  • interfaceDescription (string) – SDA’s User defined text message for port assignment .

  • interfaceName (string) – SDA’s Interface Name on the Edge Node Device. .

  • interfaceNames (list) – SDA’s List of Interface Names on the Edge Node Device. E.g.[“GigabitEthernet1/0/3”,”GigabitEthernet1/0/4”] (list of strings).

  • scalableGroupName (string) – SDA’s Scalable Group name associated with VN .

  • siteNameHierarchy (string) – SDA’s Complete Path of SD-Access Fabric Site. .

  • voiceIpAddressPoolName (string) – SDA’s Ip Pool Name, that is assigned to virtual network with traffic type as VOICE(can’t be empty if dataIpAddressPoolName is empty) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-port-assignment-for-user-device

get_port_assignment_for_user_device(device_management_ip_address, interface_name, headers=None, **request_parameters)[source]

Get Port assignment for user device in SDA Fabric. .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • interface_name (basestring) – interfaceName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-port-assignment-for-user-device

add_multicast_in_sda_fabric(multicastMethod=None, multicastType=None, multicastVnInfo=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add multicast in SDA fabric .

Parameters:
  • multicastMethod (string) – SDA’s Multicast Method . Available values are ‘native_multicast’.

  • multicastType (string) – SDA’s Multicast Type . Available values are ‘ssm’, ‘asm_with_internal_rp’ and ‘asm_with_external_rp’.

  • multicastVnInfo (list) – SDA’s multicastVnInfo (list of objects).

  • siteNameHierarchy (string) – SDA’s Full path of sda Fabric Site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-multicast-in-sda-fabric

get_multicast_details_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)[source]

Get multicast details from SDA fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. fabric site name hierarchy .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-multicast-details-from-sda-fabric

delete_multicast_from_sda_fabric(site_name_hierarchy, headers=None, **request_parameters)[source]

Delete multicast from SDA fabric .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-multicast-from-sda-fabric

delete_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Delete provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter. Valid IP address of the device currently provisioned in a fabric site .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-provisioned-wired-device

re_provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Re-Provision Wired Device .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be re-provisioned .

  • siteNameHierarchy (string) – SDA’s siteNameHierarchy of the provisioned device .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!re-provision-wired-device

provision_wired_device(deviceManagementIpAddress=None, siteNameHierarchy=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision Wired Device .

Parameters:
  • deviceManagementIpAddress (string) – SDA’s Management Ip Address of the device to be provisioned .

  • siteNameHierarchy (string) – SDA’s Site Name Hierarchy for device location(only building / floor level) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision-wired-device

get_provisioned_wired_device(device_management_ip_address, headers=None, **request_parameters)[source]

Get Provisioned Wired Device .

Parameters:
  • device_management_ip_address (basestring) – deviceManagementIpAddress query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-provisioned-wired-device

delete_transit_peer_network(transit_peer_network_name, headers=None, **request_parameters)[source]

Delete Transit Peer Network from SD-Access .

Parameters:
  • transit_peer_network_name (basestring) – transitPeerNetworkName query parameter. Transit Peer Network Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-transit-peer-network

get_transit_peer_network_info(transit_peer_network_name, headers=None, **request_parameters)[source]

Get Transit Peer Network Info from SD-Access .

Parameters:
  • transit_peer_network_name (basestring) – transitPeerNetworkName query parameter. Transit or Peer Network Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-transit-peer-network-info

add_transit_peer_network(ipTransitSettings=None, sdaTransitSettings=None, transitPeerNetworkName=None, transitPeerNetworkType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add Transit Peer Network in SD-Access .

Parameters:
  • ipTransitSettings (object) – SDA’s ipTransitSettings.

  • sdaTransitSettings (object) – SDA’s sdaTransitSettings.

  • transitPeerNetworkName (string) – SDA’s Transit Peer Network Name .

  • transitPeerNetworkType (string) – SDA’s Transit Peer Network Type . Available values are ‘ip_transit’, ‘sda_transit_with_lisp_bgp’ and ‘sda_transit_with_pub_sub’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-transit-peer-network

delete_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-vn

get_vn(site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network (VN) from SDA Fabric .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-vn

add_vn(siteNameHierarchy=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network (VN) in SDA Fabric .

Parameters:
  • siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

  • virtualNetworkName (string) – SDA’s Virtual Network Name, that is created at Global level .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-vn

get_virtual_network_summary(site_name_hierarchy, headers=None, **request_parameters)[source]

Get Virtual Network Summary .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter. Complete fabric siteNameHierarchy Path .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-virtual-network-summary

get_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Get IP Pool from SDA Virtual Network .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • ip_pool_name (basestring) – ipPoolName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-ip-pool-from-sda-virtual-network

delete_ip_pool_from_sda_virtual_network(ip_pool_name, site_name_hierarchy, virtual_network_name, headers=None, **request_parameters)[source]

Delete IP Pool from SDA Virtual Network .

Parameters:
  • site_name_hierarchy (basestring) – siteNameHierarchy query parameter.

  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • ip_pool_name (basestring) – ipPoolName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-ip-pool-from-sda-virtual-network

add_ip_pool_in_sda_virtual_network(autoGenerateVlanName=None, ipPoolName=None, isBridgeModeVm=None, isCommonPool=None, isIpDirectedBroadcast=None, isL2FloodingEnabled=None, isLayer2Only=None, isThisCriticalPool=None, isWirelessPool=None, poolType=None, scalableGroupName=None, siteNameHierarchy=None, trafficType=None, virtualNetworkName=None, vlanId=None, vlanName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add IP Pool in SDA Virtual Network .

Parameters:
  • autoGenerateVlanName (boolean) – SDA’s It will auto generate vlanName, if vlanName is empty(applicable for L3 and INFRA_VN) .

  • ipPoolName (string) – SDA’s Ip Pool Name, that is reserved to Fabric Site for (applicable for L3 and INFRA_VN) .

  • isBridgeModeVm (boolean) – SDA’s Bridge Mode Vm enablement flag (applicable for L3 and L2 and default value is False ) .

  • isCommonPool (boolean) – SDA’s Common Pool enablement flag(applicable for L3 and L2 and default value is False ) .

  • isIpDirectedBroadcast (boolean) – SDA’s Ip Directed Broadcast enablement flag(applicable for L3 and default value is False ) .

  • isL2FloodingEnabled (boolean) – SDA’s Layer2 flooding enablement flag(applicable for L3 , L2 and always true for L2 and default value is False ) .

  • isLayer2Only (boolean) – SDA’s Layer2 Only enablement flag and default value is False .

  • isThisCriticalPool (boolean) – SDA’s Critical pool enablement flag(applicable for L3 and default value is False ) .

  • isWirelessPool (boolean) – SDA’s Wireless Pool enablement flag(applicable for L3 and L2 and default value is False ) .

  • poolType (string) – SDA’s Pool Type (applicable for INFRA_VN) . Available values are ‘AP’ and ‘Extended’.

  • scalableGroupName (string) – SDA’s Scalable Group Name(applicable for L3) .

  • siteNameHierarchy (string) – SDA’s Path of sda Fabric Site .

  • trafficType (string) – SDA’s Traffic type(applicable for L3 and L2) . Available values are ‘Data’ and ‘Voice’.

  • virtualNetworkName (string) – SDA’s Virtual Network Name, that is associated to Fabric Site .

  • vlanId (string) – SDA’s vlan Id(applicable for L3 , L2 and INFRA_VN) .

  • vlanName (string) – SDA’s Vlan name represent the segment name, if empty, vlanName would be auto generated by API .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-ip-pool-in-sda-virtual-network

add_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, vManageVpnId=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Add virtual network with scalable groups at global level .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s Guest Virtual Network enablement flag, default value is False. .

  • scalableGroupNames (list) – SDA’s Scalable Group to be associated to virtual network (list of strings).

  • vManageVpnId (string) – SDA’s vManage vpn id for SD-WAN .

  • virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned at global level .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-virtual-network-with-scalable-groups

delete_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Delete virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-virtual-network-with-scalable-groups

get_virtual_network_with_scalable_groups(virtual_network_name, headers=None, **request_parameters)[source]

Get virtual network with scalable groups .

Parameters:
  • virtual_network_name (basestring) – virtualNetworkName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-virtual-network-with-scalable-groups

update_virtual_network_with_scalable_groups(isGuestVirtualNetwork=None, scalableGroupNames=None, vManageVpnId=None, virtualNetworkName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update virtual network with scalable groups .

Parameters:
  • isGuestVirtualNetwork (boolean) – SDA’s Indicates whether to set this as guest virtual network or not, default value is False. .

  • scalableGroupNames (list) – SDA’s Scalable Group Name to be associated to virtual network (list of strings).

  • vManageVpnId (string) – SDA’s vManage vpn id for SD-WAN .

  • virtualNetworkName (string) – SDA’s Virtual Network Name to be assigned global level .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-virtual-network-with-scalable-groups

security_advisories

class SecurityAdvisories[source]

Cisco DNA Center Security Advisories API (version: 2.3.5.3).

Wraps the DNA Center Security Advisories API and exposes the API as native Python methods that return native Python objects.

get_advisories_list(headers=None, **request_parameters)[source]

Retrieves list of advisories on the network .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisories-list

get_advisories_summary(headers=None, **request_parameters)[source]

Retrieves summary of advisories on the network. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisories-summary

get_devices_per_advisory(advisory_id, headers=None, **request_parameters)[source]

Retrieves list of devices for an advisory .

Parameters:
  • advisory_id (basestring) – advisoryId path parameter. Advisory ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-devices-per-advisory

get_advisory_ids_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisory IDs for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisory-ids-per-device

get_advisories_per_device(device_id, headers=None, **request_parameters)[source]

Retrieves list of advisories for a device .

Parameters:
  • device_id (basestring) – deviceId path parameter. Device instance UUID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-advisories-per-device

sensors

class Sensors[source]

Cisco DNA Center Sensors API (version: 2.3.5.3).

Wraps the DNA Center Sensors API and exposes the API as native Python methods that return native Python objects.

edit_sensor_test_template(locationInfoList=None, schedule=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to deploy, schedule, or edit and existing SENSOR test template .

Parameters:
  • locationInfoList (list) – Sensors’s locationInfoList (list of objects).

  • schedule (object) – Sensors’s schedule.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!edit-sensor-test-template

create_sensor_test_template(apCoverage=None, connection=None, modelVersion=None, name=None, ssids=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID .

Parameters:
  • apCoverage (list) – Sensors’s apCoverage (list of objects).

  • connection (string) – Sensors’s Connection.

  • modelVersion (integer) – Sensors’s Model Version.

  • name (string) – Sensors’s Name.

  • ssids (list) – Sensors’s ssids (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-sensor-test-template

delete_sensor_test(template_name=None, headers=None, **request_parameters)[source]

Intent API to delete an existing SENSOR test template .

Parameters:
  • template_name (basestring) – templateName query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-sensor-test

sensors(site_id=None, headers=None, **request_parameters)[source]

Intent API to get a list of SENSOR devices .

Parameters:
  • site_id (basestring) – siteId query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sensors

run_now_sensor_test(templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to run a deployed SENSOR test .

Parameters:
  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!run-now-sensor-test

duplicate_sensor_test_template(newTemplateName=None, templateName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Intent API to duplicate an existing SENSOR test template .

Parameters:
  • newTemplateName (string) – Sensors’s New Template Name.

  • templateName (string) – Sensors’s Template Name.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!duplicate-sensor-test-template

site_design

class SiteDesign[source]

Cisco DNA Center Site Design API (version: 2.3.5.3).

Wraps the DNA Center Site Design API and exposes the API as native Python methods that return native Python objects.

provision_nfv(provisioning=None, siteProfile=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Design and Provision single/multi NFV device with given site/area/building/floor . .

Parameters:
  • provisioning (list) – Site Design’s provisioning (list of objects).

  • siteProfile (list) – Site Design’s siteProfile (list of objects).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision-nfv

get_device_details_by_ip(device_ip, headers=None, **request_parameters)[source]

Returns provisioning device information for the specified IP address. .

Parameters:
  • device_ip (basestring) – deviceIp query parameter. Device to which the provisioning detail has to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-details-by-ip

associate(network_profile_id, site_id, headers=None, **request_parameters)[source]

Associate Site to a Network Profile .

Parameters:
  • network_profile_id (basestring) – networkProfileId path parameter. Network-Profile Id to be associated .

  • site_id (basestring) – siteId path parameter. Site Id to be associated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!associate

disassociate(network_profile_id, site_id, headers=None, **request_parameters)[source]

Disassociate a Site from a Network Profile .

Parameters:
  • network_profile_id (basestring) – networkProfileId path parameter. Network-Profile Id to be associated .

  • site_id (basestring) – siteId path parameter. Site Id to be associated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!disassociate

nfv_provisioning_detail(device_ip=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Checks the provisioning detail of an ENCS device including log information. .

Parameters:
  • device_ip (string) – Site Design’s Device Ip.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!nfv-provisioning-detail

create_nfv_profile(device=None, profileName=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create network profile for different NFV topologies .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • profileName (string) – Site Design’s Name of the profile to create NFV profile .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-nfv-profile

update_nfv_profile(id, device=None, name=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to update a NFV Network profile .

Parameters:
  • device (list) – Site Design’s device (list of objects).

  • id (basestring) – id path parameter. Id of the NFV profile to be updated .

  • name (basestring) – name query parameter. Name of the profile to be updated .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-nfv-profile

get_nfv_profile(id, limit=None, name=None, offset=None, headers=None, **request_parameters)[source]

API to get NFV network profile. .

Parameters:
  • id (basestring) – id path parameter. ID of network profile to retrieve. .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of profile to be retrieved .

  • name (basestring) – name query parameter. Name of network profile to be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-nfv-profile

delete_nfv_profile(id, name=None, headers=None, **request_parameters)[source]

API to delete nfv network profile. .

Parameters:
  • id (basestring) – id path parameter. Id of nfv network profile to delete. .

  • name (basestring) – name query parameter. Nameof nfv network profile to delete. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-nfv-profile

sites

class Sites[source]

Cisco DNA Center Sites API (version: 2.3.5.3).

Wraps the DNA Center Sites API and exposes the API as native Python methods that return native Python objects.

assign_devices_to_site(site_id, device=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Assigns unassigned devices to a site. This API does not move assigned devices to other sites. .

Parameters:
  • device (list) – Sites’s device (list of objects).

  • site_id (basestring) – siteId path parameter. Site id to which site the device to assign .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!assign-devices-to-site

get_membership(site_id, device_family=None, limit=None, offset=None, serial_number=None, headers=None, **request_parameters)[source]

Getting the site children details and device details. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to retrieve device associated with the site. .

  • offset (int) – offset query parameter. offset/starting row .

  • limit (int) – limit query parameter. Number of sites to be retrieved .

  • device_family (basestring) – deviceFamily query parameter. Device family name .

  • serial_number (basestring) – serialNumber query parameter. Device serial number .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-membership

create_site(site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates site with area/building/floor with specified hierarchy. .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type of site to create (eg: area, building, floor) . Available values are ‘area’, ‘building’ and ‘floor’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-site

get_site(limit=None, name=None, offset=None, site_id=None, type=None, headers=None, **request_parameters)[source]

Get site using siteNameHierarchy/siteId/type ,return all sites if these parameters are not given as input. .

Parameters:
  • name (basestring) – name query parameter. siteNameHierarchy (ex: global/groupName) .

  • site_id (basestring) – siteId query parameter. Site id to which site details to retrieve. .

  • type (basestring) – type query parameter. type (ex: area, building, floor) .

  • offset (int) – offset query parameter. offset/starting row. The default value is 1 .

  • limit (int) – limit query parameter. Number of sites to be retrieved. The default value is 500 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site

get_site_health(limit=None, offset=None, site_type=None, timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Health information for all sites .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required .

  • site_type (basestring) – siteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA .

  • offset (int) – offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. .

  • limit (int) – limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site-health

get_site_count(site_id=None, headers=None, **request_parameters)[source]

API to get site count .

Parameters:
  • site_id (basestring) – siteId query parameter. Site id to retrieve site count. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site-count

update_site(site_id, site=None, type=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update site area/building/floor with specified hierarchy and new values .

Parameters:
  • site (object) – Sites’s site.

  • type (string) – Sites’s Type. Available values are ‘area’, ‘building’ and ‘floor’.

  • site_id (basestring) – siteId path parameter. Site id to which site details to be updated. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-site

delete_site(site_id, headers=None, **request_parameters)[source]

Delete site with area/building/floor by siteId. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site id to which site details to be deleted. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-site

software_image_management_swim

class SoftwareImageManagementSwim[source]

Cisco DNA Center Software Image Management (SWIM) API (version: 2.3.5.3).

Wraps the DNA Center Software Image Management (SWIM) API and exposes the API as native Python methods that return native Python objects.

trigger_software_image_activation(schedule_validate=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Activates a software image on a given device. Software image must be present in the device flash .

Parameters:
  • schedule_validate (bool) – scheduleValidate query parameter. scheduleValidate, validates data before schedule (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!trigger-software-image-activation

trigger_software_image_distribution(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!trigger-software-image-distribution

get_software_image_details(application_type=None, created_time=None, family=None, image_integrity_status=None, image_name=None, image_series=None, image_size_greater_than=None, image_size_lesser_than=None, image_uuid=None, is_cco_latest=None, is_cco_recommended=None, is_tagged_golden=None, limit=None, name=None, offset=None, sort_by=None, sort_order=None, version=None, headers=None, **request_parameters)[source]

Returns software image list based on a filter criteria. For example: “filterbyName = cat3k%” .

Parameters:
  • image_uuid (basestring) – imageUuid query parameter.

  • name (basestring) – name query parameter.

  • family (basestring) – family query parameter.

  • application_type (basestring) – applicationType query parameter.

  • image_integrity_status (basestring) – imageIntegrityStatus query parameter. imageIntegrityStatus FAILURE, UNKNOWN, VERIFIED .

  • version (basestring) – version query parameter. software Image Version .

  • image_series (basestring) – imageSeries query parameter. image Series .

  • image_name (basestring) – imageName query parameter. image Name .

  • is_tagged_golden (bool) – isTaggedGolden query parameter. is Tagged Golden .

  • is_cco_recommended (bool) – isCCORecommended query parameter. is recommended from cisco.com .

  • is_cco_latest (bool) – isCCOLatest query parameter. is latest from cisco.com .

  • created_time (int) – createdTime query parameter. time in milliseconds (epoch format) .

  • image_size_greater_than (int) – imageSizeGreaterThan query parameter. size in bytes .

  • image_size_lesser_than (int) – imageSizeLesserThan query parameter. size in bytes .

  • sort_by (basestring) – sortBy query parameter. sort results by this field .

  • sort_order (basestring) – sortOrder query parameter. sort order ‘asc’ or ‘des’. Default is asc .

  • limit (int) – limit query parameter.

  • offset (int) – offset query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-software-image-details

get_device_family_identifiers(headers=None, **request_parameters)[source]

API to get Device Family Identifiers for all Device Families that can be used for tagging an image golden. .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-device-family-identifiers

tag_as_golden_image(deviceFamilyIdentifier=None, deviceRole=None, imageId=None, siteId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Golden Tag image. Set siteId as -1 for Global site. .

Parameters:
  • deviceFamilyIdentifier (string) – Software Image Management (SWIM)’s Device Family Identifier e.g. : 277696480-283933147, 277696480 .

  • deviceRole (string) – Software Image Management (SWIM)’s Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • imageId (string) – Software Image Management (SWIM)’s imageId in uuid format. .

  • siteId (string) – Software Image Management (SWIM)’s SiteId in uuid format. For Global Site “-1” to be used. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!tag-as-golden-image

remove_golden_tag_for_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)[source]

Remove golden tag. Set siteId as -1 for Global site. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

  • device_family_identifier (basestring) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

  • device_role (basestring) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • image_id (basestring) – imageId path parameter. Image Id in uuid format. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-golden-tag-for-image

get_golden_tag_status_of_an_image(device_family_identifier, device_role, image_id, site_id, headers=None, **request_parameters)[source]

Get golden tag status of an image. Set siteId as -1 for Global site. .

Parameters:
  • site_id (basestring) – siteId path parameter. Site Id in uuid format. Set siteId as -1 for Global site. .

  • device_family_identifier (basestring) – deviceFamilyIdentifier path parameter. Device family identifier e.g. : 277696480-283933147, e.g. : 277696480 .

  • device_role (basestring) – deviceRole path parameter. Device Role. Permissible Values : ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. .

  • image_id (basestring) – imageId path parameter. Image Id in uuid format. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-golden-tag-status-of-an-image

import_local_software_image(multipart_fields, multipart_monitor_callback, is_third_party=None, third_party_application_type=None, third_party_image_family=None, third_party_vendor=None, headers=None, **request_parameters)[source]

Fetches a software image from local file system and uploads to DNA Center. Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2 .

The following code gives an example of the multipart_fields.

multipart_fields={'file': ('file.zip', open('file.zip', 'rb')}
multipart_fields={'file': ('file.txt', open('file.txt', 'rb'),
    'text/plain',
    {'X-My-Header': 'my-value'})}
multipart_fields=[('images', ('foo.png', open('foo.png', 'rb'),
    'image/png')),
    ('images', ('bar.png', open('bar.png', 'rb'), 'image/png'))]

The following example demonstrates how to use multipart_monitor_callback=create_callback to create a progress bar using clint.

from clint.textui.progress import Bar
def create_callback(encoder):
    encoder_len = encoder.len
    bar = Bar(expected_size=encoder_len,
              filled_char="=")
    def callback(monitor):
        bar.show(monitor.bytes_read)
    return callback
Parameters:
  • is_third_party (bool) – isThirdParty query parameter. Third party Image check .

  • third_party_vendor (basestring) – thirdPartyVendor query parameter. Third Party Vendor .

  • third_party_image_family (basestring) – thirdPartyImageFamily query parameter. Third Party image family .

  • third_party_application_type (basestring) – thirdPartyApplicationType query parameter. Third Party Application Type .

  • multipart_fields (dict) – Fields from which to create a multipart/form-data body.

  • multipart_monitor_callback (function) – function used to monitor the progress of the upload.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-local-software-image

import_software_image_via_url(schedule_at=None, schedule_desc=None, schedule_origin=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2 .

Parameters:
  • schedule_at (basestring) – scheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional) .

  • schedule_desc (basestring) – scheduleDesc query parameter. Custom Description (Optional) .

  • schedule_origin (basestring) – scheduleOrigin query parameter. Originator of this call (Optional) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!import-software-image-via-url

system_settings

class SystemSettings[source]

Cisco DNA Center System Settings API (version: 2.3.5.3).

Wraps the DNA Center System Settings API and exposes the API as native Python methods that return native Python objects.

get_authentication_and_policy_servers(is_ise_enabled=None, role=None, state=None, headers=None, **request_parameters)[source]

API to get Authentication and Policy Servers .

Parameters:
  • is_ise_enabled (bool) – isIseEnabled query parameter. Valid values are : true, false .

  • state (basestring) – state query parameter. Valid values are: INPROGRESS, ACTIVE, DELETED, RBAC-FAILURE, FAILED .

  • role (basestring) – role query parameter. Authentication and Policy Server Role (Example: primary, secondary) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-authentication-and-policy-servers

custom_prompt_support_g_e_t_api(headers=None, **request_parameters)[source]

Returns supported custom prompts by Cisco DNA Center .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!custom-prompt-support-g-e-t-api

custom_prompt_p_o_s_t_api(passwordPrompt=None, usernamePrompt=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Save custom prompt added by user in Cisco DNA Center. API will always override the existing prompts. User should provide all the custom prompt in case of any update .

Parameters:
  • passwordPrompt (string) – System Settings’s Password Prompt.

  • usernamePrompt (string) – System Settings’s Username Prompt.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!custom-prompt-p-o-s-t-api

tag

class Tag[source]

Cisco DNA Center Tag API (version: 2.3.5.3).

Wraps the DNA Center Tag API and exposes the API as native Python methods that return native Python objects.

update_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates a tag specified by id .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-tag

get_tag(additional_info_attributes=None, additional_info_name_space=None, field=None, level=None, limit=None, name=None, offset=None, order=None, size=None, sort_by=None, system_tag=None, headers=None, **request_parameters)[source]

Returns the tags for given filter criteria .

Parameters:
  • name (basestring) – name query parameter. Tag name is mandatory when filter operation is used. .

  • additional_info_name_space (basestring) – additionalInfo.nameSpace query parameter.

  • additional_info_attributes (basestring) – additionalInfo.attributes query parameter.

  • level (basestring) – level query parameter.

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • field (basestring) – field query parameter. Available field names are :’name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’ .

  • sort_by (basestring) – sortBy query parameter. Only supported attribute is name. SortyBy is mandatory when order is used. .

  • order (basestring) – order query parameter. Available values are asc and des .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag

create_tag(description=None, dynamicRules=None, id=None, instanceTenantId=None, name=None, systemTag=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates tag with specified tag attributes .

Parameters:
  • description (string) – Tag’s description.

  • dynamicRules (list) – Tag’s dynamicRules (list of objects).

  • id (string) – Tag’s id.

  • instanceTenantId (string) – Tag’s instanceTenantId.

  • name (string) – Tag’s name.

  • systemTag (boolean) – Tag’s systemTag.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-tag

get_tag_count(attribute_name=None, level=None, name=None, name_space=None, size=None, system_tag=None, headers=None, **request_parameters)[source]

Returns tag count .

Parameters:
  • name (basestring) – name query parameter.

  • name_space (basestring) – nameSpace query parameter.

  • attribute_name (basestring) – attributeName query parameter.

  • level (basestring) – level query parameter.

  • size (basestring) – size query parameter. size in kilobytes(KB) .

  • system_tag (basestring) – systemTag query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-count

updates_tag_membership(memberToTags=None, memberType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API .

Parameters:
  • memberToTags (list) – Tag’s memberToTags (list of objects).

  • memberType (string) – Tag’s memberType.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!updates-tag-membership

get_tag_resource_types(headers=None, **request_parameters)[source]

Returns list of supported resource types .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-resource-types

delete_tag(id, headers=None, **request_parameters)[source]

Deletes a tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-tag

get_tag_by_id(id, headers=None, **request_parameters)[source]

Returns tag specified by Id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-by-id

get_tag_members_by_id(id, member_type, level=None, limit=None, member_association_type=None, offset=None, headers=None, **request_parameters)[source]

Returns tag members specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API .

  • offset (basestring) – offset query parameter. Used for pagination. It indicates the starting row number out of available member records .

  • limit (basestring) – limit query parameter. Used to Number of maximum members to return in the result .

  • member_association_type (basestring) – memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag manually. 3) MIXED – The member is associated manually and also satisfies the rule defined for the tag .

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-members-by-id

add_members_to_the_tag(id, object=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Adds members to the tag specified by id .

Parameters:
  • object (string) – Tag’s object.

  • id (basestring) – id path parameter. Tag ID .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!add-members-to-the-tag

get_tag_member_count(id, member_type, level=None, member_association_type=None, headers=None, **request_parameters)[source]

Returns the number of members in a given tag .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_type (basestring) – memberType query parameter.

  • member_association_type (basestring) – memberAssociationType query parameter.

  • level (basestring) – level query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tag-member-count

remove_tag_member(id, member_id, headers=None, **request_parameters)[source]

Removes Tag member from the tag specified by id .

Parameters:
  • id (basestring) – id path parameter. Tag ID .

  • member_id (basestring) – memberId path parameter. TagMember id to be removed from tag .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!remove-tag-member

task

class Task[source]

Cisco DNA Center Task API (version: 2.3.5.3).

Wraps the DNA Center Task API and exposes the API as native Python methods that return native Python objects.

get_business_api_execution_details(execution_id, headers=None, **request_parameters)[source]

Retrieves the execution details of a Business API .

Parameters:
  • execution_id (basestring) – executionId path parameter. Execution Id of API .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-business-api-execution-details

get_tasks(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, limit=None, offset=None, order=None, parent_id=None, progress=None, service_type=None, sort_by=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns task(s) based on filter criteria .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • offset (int) – offset query parameter.

  • limit (int) – limit query parameter.

  • sort_by (basestring) – sortBy query parameter. Sort results by this field .

  • order (basestring) – order query parameter. Sort order asc or dsc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-tasks

get_task_count(data=None, end_time=None, error_code=None, failure_reason=None, is_error=None, parent_id=None, progress=None, service_type=None, start_time=None, username=None, headers=None, **request_parameters)[source]

Returns Task count .

Parameters:
  • start_time (basestring) – startTime query parameter. This is the epoch start time from which tasks need to be fetched .

  • end_time (basestring) – endTime query parameter. This is the epoch end time upto which audit records need to be fetched .

  • data (basestring) – data query parameter. Fetch tasks that contains this data .

  • error_code (basestring) – errorCode query parameter. Fetch tasks that have this error code .

  • service_type (basestring) – serviceType query parameter. Fetch tasks with this service type .

  • username (basestring) – username query parameter. Fetch tasks with this username .

  • progress (basestring) – progress query parameter. Fetch tasks that contains this progress .

  • is_error (basestring) – isError query parameter. Fetch tasks ended as success or failure. Valid values: true, false .

  • failure_reason (basestring) – failureReason query parameter. Fetch tasks that contains this failure reason .

  • parent_id (basestring) – parentId query parameter. Fetch tasks that have this parent Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-count

get_task_by_operationid(limit, offset, operation_id, headers=None, **request_parameters)[source]

Returns root tasks associated with an Operationid .

Parameters:
  • operation_id (basestring) – operationId path parameter.

  • offset (int) – offset path parameter. Index, minimum value is 0 .

  • limit (int) – limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-by-operationid

get_task_by_id(task_id, headers=None, **request_parameters)[source]

Returns a task by specified id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-by-id

get_task_tree(task_id, headers=None, **request_parameters)[source]

Returns a task with its children tasks by based on their id .

Parameters:
  • task_id (basestring) – taskId path parameter. UUID of the Task .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-task-tree

topology

class Topology[source]

Cisco DNA Center Topology API (version: 2.3.5.3).

Wraps the DNA Center Topology API and exposes the API as native Python methods that return native Python objects.

get_overall_network_health(timestamp=None, headers=None, **request_parameters)[source]

Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time .

Parameters:
  • timestamp (basestring) – timestamp query parameter. Epoch time(in milliseconds) when the Network health data is required .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-overall-network-health

get_topology_details(vlan_id, headers=None, **request_parameters)[source]

Returns Layer 2 network topology by specified VLAN ID .

Parameters:
  • vlan_id (basestring) – vlanID path parameter. Vlan Name for e.g Vlan1, Vlan23 etc .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-topology-details

get_l3_topology_details(topology_type, headers=None, **request_parameters)[source]

Returns the Layer 3 network topology by routing protocol .

Parameters:
  • topology_type (basestring) – topologyType path parameter. Type of topology(OSPF,ISIS,etc) .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-l3-topology-details

get_physical_topology(node_type=None, headers=None, **request_parameters)[source]

Returns the raw physical topology by specified criteria of nodeType .

Parameters:
  • node_type (basestring) – nodeType query parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-physical-topology

get_site_topology(headers=None, **request_parameters)[source]

Returns site topology .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-site-topology

get_vlan_details(headers=None, **request_parameters)[source]

Returns the list of VLAN names .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-vlan-details

userand_roles

users

class Users[source]

Cisco DNA Center Users API (version: 2.3.5.3).

Wraps the DNA Center Users API and exposes the API as native Python methods that return native Python objects.

get_user_enrichment_details(headers=None, **request_parameters)[source]

Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-user-enrichment-details

wireless

class Wireless[source]

Cisco DNA Center Wireless API (version: 2.3.5.3).

Wraps the DNA Center Wireless API and exposes the API as native Python methods that return native Python objects.

sensor_test_results(end_time=None, site_id=None, start_time=None, test_failure_by=None, headers=None, **request_parameters)[source]

Intent API to get SENSOR test result summary .

Parameters:
  • site_id (basestring) – siteId query parameter. Assurance site UUID .

  • start_time (int) – startTime query parameter. The epoch time in milliseconds .

  • end_time (int) – endTime query parameter. The epoch time in milliseconds .

  • test_failure_by (basestring) – testFailureBy query parameter. Obtain failure statistics group by “area”, “building”, or “floor” .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!sensor-test-results

create_and_provision_ssid(enableFabric=None, flexConnect=None, managedAPLocations=None, ssidDetails=None, ssidType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites .

Parameters:
  • enableFabric (boolean) – Wireless’s Enable SSID for Fabric .

  • flexConnect (object) – Wireless’s flexConnect.

  • managedAPLocations (list) – Wireless’s Managed AP Locations (Enter entire Site(s) hierarchy) (list of strings).

  • ssidDetails (object) – Wireless’s ssidDetails.

  • ssidType (string) – Wireless’s SSID Type . Available values are ‘Guest’ and ‘Enterprise’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-and-provision-ssid

delete_ssid_and_provision_it_to_devices(managed_aplocations, ssid_name, headers=None, **request_parameters)[source]

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center .

Parameters:
  • ssid_name (basestring) – ssidName path parameter.

  • managed_aplocations (basestring) – managedAPLocations path parameter.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-ssid-and-provision-it-to-devices

reboot_access_points(apMacAddresses=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Users can reboot multiple access points up-to 200 at a time using this API .

Parameters:
  • apMacAddresses (list) – Wireless’s The ethernet MAC address of the access point. (list of strings).

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!reboot-access-points

get_access_point_reboot_task_result(parent_task_id=None, headers=None, **request_parameters)[source]

Users can query the access point reboot status using this intent API .

Parameters:
  • parent_task_id (basestring) – parentTaskId query parameter. task id of ap reboot request .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-access-point-reboot-task-result

get_enterprise_ssid(ssid_name=None, headers=None, **request_parameters)[source]

Gets either one or all the enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName query parameter. Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved. .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-enterprise-ssid

create_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, nasOptions=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout.

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcase SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service.

  • enableFastLane (boolean) – Wireless’s Enable FastLane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List.

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client. Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s SSID NAME .

  • nasOptions (list) – Wireless’s Nas Options (list of strings).

  • passphrase (string) – Wireless’s Passphrase .

  • radioPolicy (string) – Wireless’s Radio Policy Enum (enum: Triple band operation (2.4GHz, 5GHz and 6GHz), Triple band operation with band select, 5GHz only, 2.4GHz only, 6GHz only) . Available values are ‘Triple band operation (2.4GHz, 5GHz and 6GHz)’, ‘Triple band operation with band select’, ‘5GHz only’, ‘2.4GHz only’ and ‘6GHz only’.

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’, ‘OPEN’, ‘WPA3_ENTERPRISE’, ‘WPA3_PERSONAL’, ‘WPA2_WPA3_PERSONAL’ and ‘WPA2_WPA3_ENTERPRISE’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type Enum (voicedata or data ) . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-enterprise-ssid

update_enterprise_ssid(basicServiceSetClientIdleTimeout=None, clientExclusionTimeout=None, enableBasicServiceSetMaxIdle=None, enableBroadcastSSID=None, enableClientExclusion=None, enableDirectedMulticastService=None, enableFastLane=None, enableMACFiltering=None, enableNeighborList=None, enableSessionTimeOut=None, fastTransition=None, mfpClientProtection=None, name=None, nasOptions=None, passphrase=None, radioPolicy=None, securityLevel=None, sessionTimeOut=None, trafficType=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update enterprise SSID .

Parameters:
  • basicServiceSetClientIdleTimeout (integer) – Wireless’s Basic Service Set Client Idle Timeout.

  • clientExclusionTimeout (integer) – Wireless’s Client Exclusion Timeout .

  • enableBasicServiceSetMaxIdle (boolean) – Wireless’s Enable Basic Service Set Max Idle .

  • enableBroadcastSSID (boolean) – Wireless’s Enable Broadcase SSID .

  • enableClientExclusion (boolean) – Wireless’s Enable Client Exclusion .

  • enableDirectedMulticastService (boolean) – Wireless’s Enable Directed Multicast Service.

  • enableFastLane (boolean) – Wireless’s Enable FastLane .

  • enableMACFiltering (boolean) – Wireless’s Enable MAC Filtering .

  • enableNeighborList (boolean) – Wireless’s Enable Neighbor List.

  • enableSessionTimeOut (boolean) – Wireless’s Enable Session Timeout .

  • fastTransition (string) – Wireless’s Fast Transition . Available values are ‘Adaptive’, ‘Enable’ and ‘Disable’.

  • mfpClientProtection (string) – Wireless’s Management Frame Protection Client. Available values are ‘Optional’, ‘Disabled’ and ‘Required’.

  • name (string) – Wireless’s SSID NAME .

  • nasOptions (list) – Wireless’s Nas Options (list of strings).

  • passphrase (string) – Wireless’s Passphrase .

  • radioPolicy (string) – Wireless’s Radio Policy Enum (enum: Triple band operation (2.4GHz, 5GHz and 6GHz), Triple band operation with band select, 5GHz only, 2.4GHz only, 6GHz only) . Available values are ‘Triple band operation (2.4GHz, 5GHz and 6GHz)’, ‘Triple band operation with band select’, ‘5GHz only’, ‘2.4GHz only’ and ‘6GHz only’.

  • securityLevel (string) – Wireless’s Security Level . Available values are ‘WPA2_ENTERPRISE’, ‘WPA2_PERSONAL’, ‘OPEN’, ‘WPA3_ENTERPRISE’, ‘WPA3_PERSONAL’, ‘WPA2_WPA3_PERSONAL’ and ‘WPA2_WPA3_ENTERPRISE’.

  • sessionTimeOut (integer) – Wireless’s Session Time Out .

  • trafficType (string) – Wireless’s Traffic Type Enum (voicedata or data ) . Available values are ‘voicedata’ and ‘data’.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-enterprise-ssid

delete_enterprise_ssid(ssid_name, headers=None, **request_parameters)[source]

Deletes given enterprise SSID .

Parameters:
  • ssid_name (basestring) – ssidName path parameter. Enter the SSID name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-enterprise-ssid

delete_wireless_profile(wireless_profile_name, headers=None, **request_parameters)[source]

Delete the Wireless Profile from Cisco DNA Center whose name is provided. .

Parameters:
  • wireless_profile_name (basestring) – wirelessProfileName path parameter. Wireless Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-wireless-profile

configure_access_points(adminStatus=None, apHeight=None, apList=None, apMode=None, configureAdminStatus=None, configureApHeight=None, configureApMode=None, configureFailoverPriority=None, configureHAController=None, configureLedBrightnessLevel=None, configureLedStatus=None, configureLocation=None, failoverPriority=None, ledBrightnessLevel=None, ledStatus=None, location=None, primaryControllerName=None, primaryIpAddress=None, radioConfigurations=None, secondaryControllerName=None, secondaryIpAddress=None, tertiaryControllerName=None, tertiaryIpAddress=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

User can configure multiple access points with required options using this intent API .

Parameters:
  • adminStatus (boolean) – Wireless’s Configure the access point’s admin status. Set this parameter’s value to “true” to enable it and “false” to disable it. .

  • apHeight (number) – Wireless’s Configure the height of the access point by setting a value between 3 and height of the floor. .

  • apList (list) – Wireless’s apList (list of objects).

  • apMode (integer) – Wireless’s Configure the access point’s mode: for local/flexconnect mode, set “0”; for monitor mode, set “1”; for sniffer mode, set “4”; and for bridge/flex+bridge mode, set “5”. .

  • configureAdminStatus (boolean) – Wireless’s To change the access point’s admin status, set this parameter’s value to “true”. .

  • configureApHeight (boolean) – Wireless’s To change the access point’s height, set this parameter’s value to “true”. .

  • configureApMode (boolean) – Wireless’s To change the access point’s mode, set this parameter’s value to “true”. .

  • configureFailoverPriority (boolean) – Wireless’s To change the access point’s failover priority, set this parameter’s value to “true”. .

  • configureHAController (boolean) – Wireless’s To change the access point’s HA controller, set this parameter’s value to “true”. .

  • configureLedBrightnessLevel (boolean) – Wireless’s To change the access point’s LED brightness level, set this parameter’s value to “true”. .

  • configureLedStatus (boolean) – Wireless’s To change the access point’s LED status, set this parameter’s value to “true”. .

  • configureLocation (boolean) – Wireless’s To change the access point’s location, set this parameter’s value to “true”. .

  • failoverPriority (integer) – Wireless’s Configure the acess point’s failover priority: for low, set “1”; for medium, set “2”; for high, set “3”; and for critical, set “4”. .

  • ledBrightnessLevel (integer) – Wireless’s Configure the access point’s LED brightness level by setting a value between 1 and 8. .

  • ledStatus (boolean) – Wireless’s Configure the access point’s LED status. Set “true” to enable its status and “false” to disable it. .

  • location (string) – Wireless’s Configure the access point’s location. .

  • primaryControllerName (string) – Wireless’s Configure the hostname for an access point’s primary controller. .

  • primaryIpAddress (object) – Wireless’s primaryIpAddress.

  • radioConfigurations (list) – Wireless’s radioConfigurations (list of objects).

  • secondaryControllerName (string) – Wireless’s Configure the hostname for an access point’s secondary controller. .

  • secondaryIpAddress (object) – Wireless’s secondaryIpAddress.

  • tertiaryControllerName (string) – Wireless’s Configure the hostname for an access point’s tertiary controller. .

  • tertiaryIpAddress (object) – Wireless’s tertiaryIpAddress.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!configure-access-points

get_access_point_configuration_task_result(task_id, headers=None, **request_parameters)[source]

Users can query the access point configuration result using this intent API .

Parameters:
  • task_id (basestring) – task_id path parameter. task id information of ap config .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-access-point-configuration-task-result

get_access_point_configuration(key, headers=None, **request_parameters)[source]

Users can query the access point configuration information per device using the ethernet MAC address .

Parameters:
  • key (basestring) – key query parameter. The ethernet MAC address of Access point .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-access-point-configuration

ap_provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Access Point Provision and ReProvision .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!ap-provision

create_update_dynamic_interface(interfaceName=None, vlanId=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

API to create or update an dynamic interface .

Parameters:
  • interfaceName (string) – Wireless’s dynamic-interface name .

  • vlanId (number) – Wireless’s Vlan Id .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-update-dynamic-interface

get_dynamic_interface(interface_name=None, headers=None, **request_parameters)[source]

Get one or all dynamic interface(s) .

Parameters:
  • interface_name (basestring) – interface-name query parameter. dynamic-interface name, if not specified all the existing dynamic interfaces will be retrieved .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-dynamic-interface

delete_dynamic_interface(interface_name, headers=None, **request_parameters)[source]

Delete a dynamic interface .

Parameters:
  • interface_name (basestring) – interfaceName path parameter. valid interface-name to be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-dynamic-interface

update_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!update-wireless-profile

create_wireless_profile(profileDetails=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Creates Wireless Network Profile on Cisco DNA Center and associates sites and SSIDs to it. .

Parameters:
  • profileDetails (object) – Wireless’s profileDetails.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-wireless-profile

get_wireless_profile(profile_name=None, headers=None, **request_parameters)[source]

Gets either one or all the wireless network profiles if no name is provided for network-profile. .

Parameters:
  • profile_name (basestring) – profileName query parameter. Wireless Network Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. A list of MyDict objects. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

list

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!get-wireless-profile

provision_update(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Updates wireless provisioning .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision-update

provision(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Provision wireless devices .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!provision

psk_override(headers=None, payload=None, active_validation=True, **request_parameters)[source]

Update/override pass phrase of enterprise SSID .

Parameters:
  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (list) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!psk-override

retrieve_rf_profiles(rf_profile_name=None, headers=None, **request_parameters)[source]

Retrieve all RF profiles .

Parameters:
  • rf_profile_name (basestring) – rf-profile-name query parameter. RF Profile Name .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!retrieve-rf-profiles

create_or_update_rf_profile(channelWidth=None, defaultRfProfile=None, enableBrownField=None, enableCustom=None, enableRadioTypeA=None, enableRadioTypeB=None, enableRadioTypeC=None, name=None, radioTypeAProperties=None, radioTypeBProperties=None, radioTypeCProperties=None, headers=None, payload=None, active_validation=True, **request_parameters)[source]

Create or Update RF profile .

Parameters:
  • channelWidth (string) – Wireless’s Channel Width .

  • defaultRfProfile (boolean) – Wireless’s is Default Rf Profile .

  • enableBrownField (boolean) – Wireless’s Enable Brown Field .

  • enableCustom (boolean) – Wireless’s Enable Custom .

  • enableRadioTypeA (boolean) – Wireless’s Enable Radio Type A .

  • enableRadioTypeB (boolean) – Wireless’s Enable Radio Type B .

  • enableRadioTypeC (boolean) – Wireless’s Enable Radio Type C (6GHz) .

  • name (string) – Wireless’s RF Profile Name .

  • radioTypeAProperties (object) – Wireless’s radioTypeAProperties.

  • radioTypeBProperties (object) – Wireless’s radioTypeBProperties.

  • radioTypeCProperties (object) – Wireless’s radioTypeCProperties.

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • payload (dict) – A JSON serializable Python object to send in the body of the Request.

  • active_validation (bool) – Enable/Disable payload validation. Defaults to True.

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!create-or-update-rf-profile

delete_rf_profiles(rf_profile_name, headers=None, **request_parameters)[source]

Delete RF profile(s) .

Parameters:
  • rf_profile_name (basestring) – rfProfileName path parameter. RF profile name to be deleted(required) *non- custom RF profile cannot be deleted .

  • headers (dict) – Dictionary of HTTP Headers to send with the Request .

  • **request_parameters – Additional request parameters (provides support for parameters that may be added in the future).

Returns:

JSON response. Access the object’s properties by using the dot notation or the bracket notation.

Return type:

MyDict

Raises:
  • TypeError – If the parameter types are incorrect.

  • MalformedRequest – If the request body created is invalid.

  • ApiError – If the DNA Center cloud returns an error.

Documentation Link:

https://developer.cisco.com/docs/dna-center/#!delete-rf-profiles

DNA Center Data Object

MyDict

class MyDict[source]

A Python _dict_ subclass which tries to act like JavaScript objects, so you can use the dot notation (.) to access members of the object. If the member doesn’t exist yet then it’s created when you assign something to it. Brackets notation (d[‘foo’]) is also possible.

has_path(key)[source]

Check existence of “path” in the tree.

d = MyDict({'foo': {'bar': 'baz'}})
d.has_path('foo.bar') == True

It only supports “dot-notation” (d.foo.bar)

get(key, default=None)[source]

Return the value for key if key is in the dictionary, else default.

to_json()[source]

Returns a JSON-like string representing this instance

DownloadResponse

class DownloadResponse[source]

Download Response wrapper.

Bases: urllib3.response.HTTPResponse. For more information check the urlib3 documentation

HTTP Response container.

property data

The HTTPResponse’s data

property filename

The downloaded filename

property dirpath

The downloaded directory path

property path

The download file path

Exceptions

exception dnacentersdkException[source]

Bases: Exception

Base class for all dnacentersdk package exceptions.

exception AccessTokenError[source]

Bases: dnacentersdkException

Raised when an incorrect DNA Center Access Token has been provided.

exception VersionError[source]

Bases: dnacentersdkException

Raised when an incorrect DNA Center version has been provided.

exception ApiError[source]

Bases: dnacentersdkException

Errors returned in response to requests sent to the DNA Center APIs.

Several data attributes are available for inspection.

response

The requests.Response object returned from the API call.

request

The requests.PreparedRequest of the API call.

status_code

The HTTP status code from the API response.

status

The HTTP status from the API response.

details

The parsed JSON details from the API response.

message

The error message from the parsed API response.

description

A description of the HTTP Response Code from the API docs.

exception RateLimitError[source]

Bases: ApiError

Cisco DNA Center Rate-Limit exceeded Error.

Raised when a rate-limit exceeded message is received and the request will not be retried.

retry_after

The Retry-After time period (in seconds) provided by DNA Center.

Defaults to 15 seconds if the response Retry-After header isn’t present in the response headers, and defaults to a minimum wait time of 1 second if DNA Center returns a Retry-After header of 0 seconds.

exception RateLimitWarning[source]

Bases: UserWarning

Cisco DNA Center rate-limit exceeded warning.

Raised when a rate-limit exceeded message is received and the request will be retried.

retry_after

The Retry-After time period (in seconds) provided by DNA Center.

Defaults to 15 seconds if the response Retry-After header isn’t present in the response headers, and defaults to a minimum wait time of 1 second if DNA Center returns a Retry-After header of 0 seconds.

exception MalformedRequest[source]

Bases: dnacentersdkException

Raised when a malformed request is received from DNA Center user.

exception DownloadFailure[source]

Bases: dnacentersdkException

Errors returned in response to requests sent to the DNA Center APIs with stream=True.

Several data attributes are available for inspection.

response

The requests.Response object returned from the API call.

request

The requests.PreparedRequest of the API call.

status_code

The HTTP status code from the API response.

status

The HTTP status from the API response.

original_error

The original exception

raw

The raw value of the API response

Copyright (c) 2019-2021 Cisco Systems.