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()`

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

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 (or DNA_CENTER_VERIFY_STRING) 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’].

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

User API Doc¶

DNACenterAPI¶

DNACenterAPI summary structure¶

v1.2.10 summary¶

v1.3.0 summary¶

v1.3.1 summary¶

v1.3.3 summary¶

v2.1.1 summary¶

v2.1.2 summary¶

v2.2.1 summary¶

v2.2.2.3 summary¶

v2.2.3.3 summary¶

DNACenterAPI Class¶

authentication¶

custom_caller¶

DNACenterAPI v1.2.10¶

clients¶

command_runner¶

devices¶

fabric_wired¶

file¶

network_discovery¶

networks¶

non_fabric_wireless¶

path_trace¶

pnp¶

swim¶

site_profile¶

sites¶

tag¶

task¶

template_programmer¶

DNACenterAPI v1.3.0¶

clients¶

command_runner¶

devices¶

fabric_wired¶

file¶

network_discovery¶

networks¶

non_fabric_wireless¶

path_trace¶

pnp¶

swim¶

site_profile¶

sites¶

tag¶

task¶

template_programmer¶

DNACenterAPI v1.3.1¶

application_policy¶

clients¶

command_runner¶

configuration_templates¶

device_onboarding_pnp¶

devices¶

event_management¶

fabric_wired¶

file¶

issues¶

network_discovery¶

network_settings¶

non_fabric_wireless¶

path_trace¶

site_design¶

sites¶

software_image_management_swim¶

tag¶

task¶

topology¶

users¶

DNACenterAPI v1.3.3¶

application_policy¶

clients¶

command_runner¶

configuration_templates¶

device_onboarding_pnp¶

devices¶

discovery¶

event_management¶