.. _User API Doc: .. currentmodule:: catalystcentersdk ============ User API Doc ============ ----------------- CatalystCenterAPI ----------------- The :class:`CatalystCenterAPI` class creates "connection objects" for working with the Catalyst Center APIs and hierarchically organizes the Catalyst Center APIs and their endpoints underneath these connection objects. CatalystCenterAPI summary structure =================================== .. _v2_3_7_6_1 summary: v2.3.7.6 summary ------------------ .. include:: api_structure_table_v2_3_7_6_1.rst .. _v2_3_7_9 summary: v2.3.7.9 summary ------------------ .. include:: api_structure_table_v2_3_7_9.rst CatalystCenterAPI Class ======================= .. autoclass:: CatalystCenterAPI() :members: .. automethod:: CatalystCenterAPI.__init__ .. _authentication: authentication -------------- .. autoclass:: catalystcentersdk.api.authentication.Authentication() .. _custom_caller: custom_caller ------------- .. autoclass:: catalystcentersdk.api.custom_caller.CustomCaller() CatalystCenterAPI v2.3.7.6 ============================ .. _ai_endpoint_analytics_2_3_7_6_1: ai_endpoint_analytics ---------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.ai_endpoint_analytics.AIEndpointAnalytics() .. _application_policy_2_3_7_6_1: application_policy ------------------ .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.application_policy.ApplicationPolicy() .. _applications_2_3_7_6_1: applications ------------ .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.applications.Applications() .. _authentication_management_2_3_7_6_1: authentication_management ------------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.authentication_management.AuthenticationManagement() .. _cisco_trusted_certificates_2_3_7_6_1: cisco_trusted_certificates -------------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.cisco_trusted_certificates.CiscoTrustedCertificates() .. _clients_2_3_7_6_1: clients ------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.clients.Clients() .. _command_runner_2_3_7_6_1: command_runner -------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.command_runner.CommandRunner() .. _compliance_2_3_7_6_1: compliance ---------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.compliance.Compliance() .. _configuration_archive_2_3_7_6_1: configuration_archive --------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.configuration_archive.ConfigurationArchive() .. _configuration_templates_2_3_7_6_1: configuration_templates ----------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.configuration_templates.ConfigurationTemplates() .. _device_onboarding_pnp_2_3_7_6_1: device_onboarding_pnp --------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.device_onboarding_pnp.DeviceOnboardingPnp() .. _device_replacement_2_3_7_6_1: device_replacement ------------------ .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.device_replacement.DeviceReplacement() .. _devices_2_3_7_6_1: devices ------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.devices.Devices() .. _disaster_recovery_2_3_7_6_1: disaster_recovery ----------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.disaster_recovery.DisasterRecovery() .. _discovery_2_3_7_6_1: discovery --------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.discovery.Discovery() .. _eox_2_3_7_6_1: eox --- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.eox.EoX() .. _event_management_2_3_7_6_1: event_management ---------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.event_management.EventManagement() .. _fabric_wireless_2_3_7_6_1: fabric_wireless --------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.fabric_wireless.FabricWireless() .. _file_2_3_7_6_1: file ---- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.file.File() .. _health_and_performance_2_3_7_6_1: health_and_performance ---------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.health_and_performance.HealthAndPerformance() .. _itsm_2_3_7_6_1: itsm ---- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.itsm.Itsm() .. _itsm_integration_2_3_7_6_1: itsm_integration ---------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.itsm_integration.ItsmIntegration() .. _issues_2_3_7_6_1: issues ------ .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.issues.Issues() .. _lan_automation_2_3_7_6_1: lan_automation -------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.lan_automation.LanAutomation() .. _licenses_2_3_7_6_1: licenses -------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.licenses.Licenses() .. _network_settings_2_3_7_6_1: network_settings ---------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.network_settings.NetworkSettings() .. _path_trace_2_3_7_6_1: path_trace ---------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.path_trace.PathTrace() .. _platform_2_3_7_6_1: platform -------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.platform.Platform() .. _reports_2_3_7_6_1: reports ------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.reports.Reports() .. _sda_2_3_7_6_1: sda --- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.sda.Sda() .. _security_advisories_2_3_7_6_1: security_advisories ------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.security_advisories.SecurityAdvisories() .. _sensors_2_3_7_6_1: sensors ------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.sensors.Sensors() .. _site_design_2_3_7_6_1: site_design ----------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.site_design.SiteDesign() .. _sites_2_3_7_6_1: sites ----- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.sites.Sites() .. _software_image_management_swim_2_3_7_6_1: software_image_management_swim ------------------------------ .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.software_image_management_swim.SoftwareImageManagementSwim() .. _system_settings_2_3_7_6_1: system_settings --------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.system_settings.SystemSettings() .. _tag_2_3_7_6_1: tag --- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.tag.Tag() .. _task_2_3_7_6_1: task ---- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.task.Task() .. _topology_2_3_7_6_1: topology -------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.topology.Topology() .. _userand_roles_2_3_7_6_1: user_and_roles ------------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.user_and_roles.UserandRoles() .. _users_2_3_7_6_1: users ----- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.users.Users() .. _wireless_2_3_7_6_1: wireless -------- .. autoclass:: catalystcentersdk.api.v2_3_7_6_1.wireless.Wireless() .. _ai_endpoint_analytics_2_3_7_9: ai_endpoint_analytics ---------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.ai_endpoint_analytics.AIEndpointAnalytics() .. _application_policy_2_3_7_9: application_policy ------------------ .. autoclass:: catalystcentersdk.api.v2_3_7_9.application_policy.ApplicationPolicy() .. _applications_2_3_7_9: applications ------------ .. autoclass:: catalystcentersdk.api.v2_3_7_9.applications.Applications() .. _cisco_i_m_c_2_3_7_9: cisco_i_m_c ----------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.cisco_i_m_c.CiscoIMC() .. _authentication_management_2_3_7_9: authentication_management ------------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.authentication_management.AuthenticationManagement() .. _cisco_trusted_certificates_2_3_7_9: cisco_trusted_certificates -------------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.cisco_trusted_certificates.CiscoTrustedCertificates() .. _clients_2_3_7_9: clients ------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.clients.Clients() .. _command_runner_2_3_7_9: command_runner -------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.command_runner.CommandRunner() .. _compliance_2_3_7_9: compliance ---------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.compliance.Compliance() .. _configuration_archive_2_3_7_9: configuration_archive --------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.configuration_archive.ConfigurationArchive() .. _configuration_templates_2_3_7_9: configuration_templates ----------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.configuration_templates.ConfigurationTemplates() .. _device_onboarding_pnp_2_3_7_9: device_onboarding_pnp --------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.device_onboarding_pnp.DeviceOnboardingPnp() .. _device_replacement_2_3_7_9: device_replacement ------------------ .. autoclass:: catalystcentersdk.api.v2_3_7_9.device_replacement.DeviceReplacement() .. _devices_2_3_7_9: devices ------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.devices.Devices() .. _disaster_recovery_2_3_7_9: disaster_recovery ----------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.disaster_recovery.DisasterRecovery() .. _discovery_2_3_7_9: discovery --------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.discovery.Discovery() .. _eox_2_3_7_9: eox --- .. autoclass:: catalystcentersdk.api.v2_3_7_9.eox.EoX() .. _event_management_2_3_7_9: event_management ---------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.event_management.EventManagement() .. _fabric_wireless_2_3_7_9: fabric_wireless --------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.fabric_wireless.FabricWireless() .. _file_2_3_7_9: file ---- .. autoclass:: catalystcentersdk.api.v2_3_7_9.file.File() .. _health_and_performance_2_3_7_9: health_and_performance ---------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.health_and_performance.HealthAndPerformance() .. _itsm_2_3_7_9: itsm ---- .. autoclass:: catalystcentersdk.api.v2_3_7_9.itsm.Itsm() .. _itsm_integration_2_3_7_9: itsm_integration ---------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.itsm_integration.ItsmIntegration() .. _issues_2_3_7_9: issues ------ .. autoclass:: catalystcentersdk.api.v2_3_7_9.issues.Issues() .. _lan_automation_2_3_7_9: lan_automation -------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.lan_automation.LanAutomation() .. _licenses_2_3_7_9: licenses -------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.licenses.Licenses() .. _network_settings_2_3_7_9: network_settings ---------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.network_settings.NetworkSettings() .. _path_trace_2_3_7_9: path_trace ---------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.path_trace.PathTrace() .. _platform_2_3_7_9: platform -------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.platform.Platform() .. _reports_2_3_7_9: reports ------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.reports.Reports() .. _sda_2_3_7_9: sda --- .. autoclass:: catalystcentersdk.api.v2_3_7_9.sda.Sda() .. _security_advisories_2_3_7_9: security_advisories ------------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.security_advisories.SecurityAdvisories() .. _sensors_2_3_7_9: sensors ------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.sensors.Sensors() .. _site_design_2_3_7_9: site_design ----------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.site_design.SiteDesign() .. _sites_2_3_7_9: sites ----- .. autoclass:: catalystcentersdk.api.v2_3_7_9.sites.Sites() .. _software_image_management_swim_2_3_7_9: software_image_management_swim ------------------------------ .. autoclass:: catalystcentersdk.api.v2_3_7_9.software_image_management_swim.SoftwareImageManagementSwim() .. _system_settings_2_3_7_9: system_settings --------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.system_settings.SystemSettings() .. _tag_2_3_7_9: tag --- .. autoclass:: catalystcentersdk.api.v2_3_7_9.tag.Tag() .. _task_2_3_7_9: task ---- .. autoclass:: catalystcentersdk.api.v2_3_7_9.task.Task() .. _topology_2_3_7_9: topology -------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.topology.Topology() .. _user_and_roles_2_3_7_9: user_and_roles ------------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.user_and_roles.UserandRoles() .. _users_2_3_7_9: users ----- .. autoclass:: catalystcentersdk.api.v2_3_7_9.users.Users() .. _wireless_2_3_7_9: wireless -------- .. autoclass:: catalystcentersdk.api.v2_3_7_9.wireless.Wireless() .. _v3_1_6_0 summary: v3.1.6.0 summary ---------------- .. include:: api_structure_table_v3_1_6_0.rst CatalystCenterAPI Class ======================= .. autoclass:: CatalystCenterAPI() :members: .. automethod:: CatalystCenterAPI.__init__ .. _authentication: authentication -------------- .. autoclass:: catalystcentersdk.api.authentication.Authentication() .. _custom_caller: custom_caller ------------- .. autoclass:: catalystcentersdk.api.custom_caller.CustomCaller() CatalystCenterAPI v3.1.6.0 ========================== .. _ai_endpoint_analytics_3_1_6_0: ai_endpoint_analytics --------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.ai_endpoint_analytics.AiEndpointAnalytics() .. _application_policy_3_1_6_0: application_policy ------------------ .. autoclass:: catalystcentersdk.api.v3_1_6_0.application_policy.ApplicationPolicy() .. _applications_3_1_6_0: applications ------------ .. autoclass:: catalystcentersdk.api.v3_1_6_0.applications.Applications() .. _authentication_management_3_1_6_0: authentication_management ------------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.authentication_management.AuthenticationManagement() .. _backup_3_1_6_0: backup ------ .. autoclass:: catalystcentersdk.api.v3_1_6_0.backup.Backup() .. _cisco_i_m_c_3_1_6_0: cisco_i_m_c ----------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.cisco_i_m_c.CiscoIMC() .. _cisco_trusted_certificates_3_1_6_0: cisco_trusted_certificates -------------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.cisco_trusted_certificates.CiscoTrustedCertificates() .. _clients_3_1_6_0: clients ------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.clients.Clients() .. _command_runner_3_1_6_0: command_runner -------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.command_runner.CommandRunner() .. _compliance_3_1_6_0: compliance ---------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.compliance.Compliance() .. _configuration_archive_3_1_6_0: configuration_archive --------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.configuration_archive.ConfigurationArchive() .. _configuration_templates_3_1_6_0: configuration_templates ----------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.configuration_templates.ConfigurationTemplates() .. _device_onboarding_pnp_3_1_6_0: device_onboarding_pnp --------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.device_onboarding_pnp.DeviceOnboardingPnp() .. _device_replacement_3_1_6_0: device_replacement ------------------ .. autoclass:: catalystcentersdk.api.v3_1_6_0.device_replacement.DeviceReplacement() .. _devices_3_1_6_0: devices ------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.devices.Devices() .. _disaster_recovery_3_1_6_0: disaster_recovery ----------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.disaster_recovery.DisasterRecovery() .. _discovery_3_1_6_0: discovery --------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.discovery.Discovery() .. _eox_3_1_6_0: eox --- .. autoclass:: catalystcentersdk.api.v3_1_6_0.eox.Eox() .. _event_management_3_1_6_0: event_management ---------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.event_management.EventManagement() .. _fabric_wireless_3_1_6_0: fabric_wireless --------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.fabric_wireless.FabricWireless() .. _file_3_1_6_0: file ---- .. autoclass:: catalystcentersdk.api.v3_1_6_0.file.File() .. _health_and_performance_3_1_6_0: health_and_performance ---------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.health_and_performance.HealthAndPerformance() .. _itsm_3_1_6_0: itsm ---- .. autoclass:: catalystcentersdk.api.v3_1_6_0.itsm.Itsm() .. _itsm_integration_3_1_6_0: itsm_integration ---------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.itsm_integration.ItsmIntegration() .. _industrial_configuration_3_1_6_0: industrial_configuration ------------------------ .. autoclass:: catalystcentersdk.api.v3_1_6_0.industrial_configuration.IndustrialConfiguration() .. _issues_3_1_6_0: issues ------ .. autoclass:: catalystcentersdk.api.v3_1_6_0.issues.Issues() .. _know_your_network_3_1_6_0: know_your_network ----------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.know_your_network.KnowYourNetwork() .. _lan_automation_3_1_6_0: lan_automation -------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.lan_automation.LanAutomation() .. _licenses_3_1_6_0: licenses -------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.licenses.Licenses() .. _network_settings_3_1_6_0: network_settings ---------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.network_settings.NetworkSettings() .. _path_trace_3_1_6_0: path_trace ---------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.path_trace.PathTrace() .. _platform_3_1_6_0: platform -------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.platform.Platform() .. _reports_3_1_6_0: reports ------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.reports.Reports() .. _restore_3_1_6_0: restore ------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.restore.Restore() .. _sda_3_1_6_0: sda --- .. autoclass:: catalystcentersdk.api.v3_1_6_0.sda.Sda() .. _security_advisories_3_1_6_0: security_advisories ------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.security_advisories.SecurityAdvisories() .. _sensors_3_1_6_0: sensors ------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.sensors.Sensors() .. _site_design_3_1_6_0: site_design ----------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.site_design.SiteDesign() .. _sites_3_1_6_0: sites ----- .. autoclass:: catalystcentersdk.api.v3_1_6_0.sites.Sites() .. _software_image_management_swim_3_1_6_0: software_image_management_swim ------------------------------ .. autoclass:: catalystcentersdk.api.v3_1_6_0.software_image_management_swim.SoftwareImageManagementSwim() .. _system_settings_3_1_6_0: system_settings --------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.system_settings.SystemSettings() .. _system_software_upgrade_3_1_6_0: system_software_upgrade ----------------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.system_software_upgrade.SystemSoftwareUpgrade() .. _tag_3_1_6_0: tag --- .. autoclass:: catalystcentersdk.api.v3_1_6_0.tag.Tag() .. _task_3_1_6_0: task ---- .. autoclass:: catalystcentersdk.api.v3_1_6_0.task.Task() .. _topology_3_1_6_0: topology -------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.topology.Topology() .. _userand_roles_3_1_6_0: userand_roles ------------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.userand_roles.UserandRoles() .. _users_3_1_6_0: users ----- .. autoclass:: catalystcentersdk.api.v3_1_6_0.users.Users() .. _wired_3_1_6_0: wired ----- .. autoclass:: catalystcentersdk.api.v3_1_6_0.wired.Wired() .. _wireless_3_1_6_0: wireless -------- .. autoclass:: catalystcentersdk.api.v3_1_6_0.wireless.Wireless() .. _Catalyst Center Data Object: Catalyst Center Data Object =========================== .. _MyDict: MyDict ------ .. autoclass:: catalystcentersdk.models.mydict.MyDict() :members: :exclude-members: get_dict, clear, fromkeys, pop, popitem, setdefault, update, values .. _DownloadResponse: DownloadResponse ---------------- .. autoclass:: catalystcentersdk.restsession.DownloadResponse() :members: .. _Exceptions: Exceptions ========== .. autoexception:: catalystcentersdkException() :show-inheritance: :members: .. autoexception:: AccessTokenError() :show-inheritance: :members: .. autoexception:: VersionError() :show-inheritance: :members: .. autoexception:: ApiError() :show-inheritance: :members: .. autoexception:: RateLimitError() :show-inheritance: :members: .. autoexception:: RateLimitWarning() :show-inheritance: :members: .. autoexception:: MalformedRequest() :show-inheritance: :members: .. autoexception:: DownloadFailure() :show-inheritance: :members: *Copyright (c) 2024 Cisco Systems.*