From 968e83a3a5a9a49837cabc0fa9392b3f20f5f236 Mon Sep 17 00:00:00 2001 From: William Astorga <53057769+wastorga@users.noreply.github.com> Date: Mon, 17 Jan 2022 18:18:05 -0600 Subject: [PATCH] Develop dnac 2 2 3 3 - update module documentation (#35) * Update plugin module documentation * Add get_all to site_design_floormap_info module * Update to v4.1.2 * Update documentation * Update documentation * Update documentation * Update documentation * Update documentation * Update documentation fix E501 * Update documentation, fix validate-modules * Update documentation, fix other validate-modules --- changelogs/changelog.yaml | 8 ++++++ galaxy.yml | 2 +- plugins/action/site_design_floormap_info.py | 8 +++--- plugins/modules/app_policy_default_info.py | 10 +++---- plugins/modules/app_policy_info.py | 10 +++---- plugins/modules/app_policy_intent_create.py | 10 +++---- plugins/modules/app_policy_queuing_profile.py | 16 +++++++---- .../app_policy_queuing_profile_count_info.py | 10 +++---- .../app_policy_queuing_profile_info.py | 10 +++---- plugins/modules/application_sets.py | 12 +++++---- .../modules/application_sets_count_info.py | 10 +++---- plugins/modules/application_sets_info.py | 10 +++---- plugins/modules/applications.py | 15 +++++++---- plugins/modules/applications_count_info.py | 10 +++---- plugins/modules/applications_health_info.py | 11 ++++---- plugins/modules/applications_info.py | 10 +++---- .../associate_site_to_network_profile.py | 11 ++++---- .../authentication_import_certificate.py | 10 +++---- .../authentication_import_certificate_p12.py | 10 +++---- ...business_sda_hostonboarding_ssid_ippool.py | 13 +++++---- ...ess_sda_hostonboarding_ssid_ippool_info.py | 10 +++---- ...business_sda_wireless_controller_create.py | 10 +++---- ...business_sda_wireless_controller_delete.py | 10 +++---- plugins/modules/cli_credential.py | 13 +++++---- plugins/modules/client_detail_info.py | 10 +++---- .../modules/client_enrichment_details_info.py | 12 +++++---- plugins/modules/client_health_info.py | 10 +++---- plugins/modules/client_proximity_info.py | 13 +++++---- plugins/modules/command_runner_run_command.py | 10 +++---- plugins/modules/compliance_check_run.py | 10 +++---- .../modules/compliance_device_by_id_info.py | 10 +++---- .../compliance_device_details_count_info.py | 10 +++---- .../modules/compliance_device_details_info.py | 10 +++---- plugins/modules/compliance_device_info.py | 13 +++++---- .../compliance_device_status_count_info.py | 10 +++---- plugins/modules/configuration_template.py | 13 +++++---- .../modules/configuration_template_clone.py | 10 +++---- .../modules/configuration_template_create.py | 10 +++---- .../modules/configuration_template_deploy.py | 10 +++---- ...nfiguration_template_deploy_status_info.py | 10 +++---- .../configuration_template_deploy_v2.py | 10 +++---- .../configuration_template_export_project.py | 10 +++---- .../configuration_template_export_template.py | 10 +++---- .../configuration_template_import_project.py | 10 +++---- .../configuration_template_import_template.py | 10 +++---- .../modules/configuration_template_info.py | 13 +++++---- .../modules/configuration_template_project.py | 16 +++++++---- .../configuration_template_project_info.py | 13 +++++---- .../configuration_template_version_create.py | 10 +++---- .../configuration_template_version_info.py | 10 +++---- .../modules/device_configurations_export.py | 10 +++---- plugins/modules/device_credential_create.py | 11 ++++---- plugins/modules/device_credential_delete.py | 10 +++---- plugins/modules/device_credential_info.py | 10 +++---- plugins/modules/device_credential_update.py | 11 ++++---- plugins/modules/device_details_info.py | 10 +++---- .../modules/device_enrichment_details_info.py | 10 +++---- .../device_family_identifiers_details_info.py | 10 +++---- plugins/modules/device_health_info.py | 10 +++---- .../modules/device_interface_by_ip_info.py | 10 +++---- .../modules/device_interface_count_info.py | 10 +++---- plugins/modules/device_interface_info.py | 13 +++++---- plugins/modules/device_interface_isis_info.py | 10 +++---- plugins/modules/device_interface_ospf_info.py | 10 +++---- plugins/modules/device_replacement.py | 13 +++++---- .../modules/device_replacement_count_info.py | 10 +++---- plugins/modules/device_replacement_deploy.py | 10 +++---- plugins/modules/device_replacement_info.py | 12 +++++---- .../disassociate_site_to_network_profile.py | 11 ++++---- ...terrecovery_system_operationstatus_info.py | 10 +++---- .../disasterrecovery_system_status_info.py | 10 +++---- plugins/modules/discovery.py | 18 +++++++++---- plugins/modules/discovery_count_info.py | 10 +++---- .../modules/discovery_device_count_info.py | 10 +++---- plugins/modules/discovery_device_info.py | 10 +++---- .../modules/discovery_device_range_info.py | 12 +++++---- plugins/modules/discovery_info.py | 10 +++---- plugins/modules/discovery_job_info.py | 15 +++++++---- plugins/modules/discovery_range_delete.py | 10 +++---- plugins/modules/discovery_range_info.py | 10 +++---- plugins/modules/discovery_summary_info.py | 10 +++---- .../dna_command_runner_keywords_info.py | 10 +++---- ...nacaap_management_execution_status_info.py | 10 +++---- .../endpoint_analytics_profiling_rules.py | 14 ++++++---- ...endpoint_analytics_profiling_rules_info.py | 20 +++++++++----- plugins/modules/event_api_status_info.py | 10 +++---- plugins/modules/event_artifact_count_info.py | 10 +++---- plugins/modules/event_artifact_info.py | 10 +++---- plugins/modules/event_count_info.py | 10 +++---- plugins/modules/event_info.py | 10 +++---- .../modules/event_series_audit_logs_info.py | 10 +++---- ...t_series_audit_logs_parent_records_info.py | 10 +++---- .../event_series_audit_logs_summary_info.py | 10 +++---- plugins/modules/event_series_count_info.py | 10 +++---- plugins/modules/event_series_info.py | 10 +++---- plugins/modules/event_subscription.py | 15 +++++++---- .../modules/event_subscription_count_info.py | 10 +++---- .../event_subscription_details_email_info.py | 10 +++---- .../event_subscription_details_rest_info.py | 10 +++---- .../event_subscription_details_syslog_info.py | 10 +++---- plugins/modules/event_subscription_email.py | 13 +++++---- .../modules/event_subscription_email_info.py | 10 +++---- plugins/modules/event_subscription_info.py | 10 +++---- plugins/modules/event_subscription_rest.py | 13 +++++---- .../modules/event_subscription_rest_info.py | 10 +++---- plugins/modules/event_subscription_syslog.py | 13 +++++---- .../modules/event_subscription_syslog_info.py | 10 +++---- plugins/modules/file_info.py | 10 +++---- plugins/modules/file_namespace_files_info.py | 10 +++---- plugins/modules/file_namespaces_info.py | 10 +++---- plugins/modules/global_credential_delete.py | 10 +++---- plugins/modules/global_credential_info.py | 13 +++++---- plugins/modules/global_credential_update.py | 11 ++++---- plugins/modules/global_pool.py | 16 +++++++---- plugins/modules/global_pool_info.py | 10 +++---- plugins/modules/golden_image_create.py | 10 +++---- plugins/modules/golden_tag_image_delete.py | 10 +++---- .../modules/golden_tag_image_details_info.py | 10 +++---- plugins/modules/http_read_credential.py | 13 +++++---- plugins/modules/http_write_credential.py | 13 +++++---- .../interface_network_device_detail_info.py | 10 +++---- .../modules/interface_network_device_info.py | 10 +++---- .../interface_network_device_range_info.py | 10 +++---- .../modules/issues_enrichment_details_info.py | 11 ++++---- plugins/modules/issues_info.py | 10 +++---- plugins/modules/itsm_cmdb_sync_status_info.py | 12 +++++---- .../itsm_integration_events_failed_info.py | 10 +++---- .../modules/itsm_integration_events_retry.py | 13 +++++---- plugins/modules/license_device_count_info.py | 10 +++---- .../modules/license_device_deregistration.py | 10 +++---- .../license_device_license_details_info.py | 10 +++---- .../license_device_license_summary_info.py | 10 +++---- .../modules/license_device_registration.py | 10 +++---- .../license_smart_account_details_info.py | 10 +++---- plugins/modules/license_term_details_info.py | 10 +++---- plugins/modules/license_usage_details_info.py | 10 +++---- .../modules/license_virtual_account_change.py | 10 +++---- .../license_virtual_account_details_info.py | 10 +++---- plugins/modules/netconf_credential.py | 13 +++++---- plugins/modules/network_create.py | 10 +++---- plugins/modules/network_device.py | 16 +++++++---- plugins/modules/network_device_by_ip_info.py | 10 +++---- .../network_device_by_serial_number_info.py | 10 +++---- .../network_device_chassis_details_info.py | 10 +++---- .../network_device_config_count_info.py | 10 +++---- plugins/modules/network_device_config_info.py | 13 ++++----- plugins/modules/network_device_count_info.py | 13 +++++---- .../modules/network_device_equipment_info.py | 10 +++---- plugins/modules/network_device_export.py | 10 +++---- ...twork_device_functional_capability_info.py | 13 +++++---- ...ork_device_global_polling_interval_info.py | 10 +++---- plugins/modules/network_device_info.py | 14 ++++++---- .../network_device_interface_poe_info.py | 11 ++++---- ...ce_inventory_insight_link_mismatch_info.py | 10 +++---- ...rk_device_lexicographically_sorted_info.py | 10 +++---- .../network_device_linecard_details_info.py | 10 +++---- ...network_device_meraki_organization_info.py | 10 +++---- .../network_device_module_count_info.py | 10 +++---- plugins/modules/network_device_module_info.py | 13 +++++---- plugins/modules/network_device_poe_info.py | 10 +++---- .../network_device_polling_interval_info.py | 10 +++---- plugins/modules/network_device_range_info.py | 10 +++---- .../network_device_register_for_wsa_info.py | 10 +++---- .../network_device_stack_details_info.py | 10 +++---- .../modules/network_device_summary_info.py | 10 +++---- ...ork_device_supervisor_card_details_info.py | 10 +++---- plugins/modules/network_device_sync.py | 12 +++++---- plugins/modules/network_device_update_role.py | 10 +++---- plugins/modules/network_device_vlan_info.py | 10 +++---- .../network_device_wireless_lan_info.py | 10 +++---- .../network_device_with_snmp_v3_des_info.py | 10 +++---- plugins/modules/network_info.py | 10 +++---- plugins/modules/network_update.py | 11 ++++---- plugins/modules/nfv_profile.py | 14 ++++++---- plugins/modules/nfv_profile_info.py | 10 +++---- plugins/modules/nfv_provision.py | 10 +++---- plugins/modules/nfv_provision_detail_info.py | 10 +++---- plugins/modules/nfv_provision_details.py | 10 +++---- plugins/modules/path_trace.py | 13 +++++---- plugins/modules/path_trace_info.py | 13 +++++---- ...atform_nodes_configuration_summary_info.py | 11 ++++---- .../modules/platform_release_summary_info.py | 11 ++++---- plugins/modules/pnp_device.py | 14 ++++++---- plugins/modules/pnp_device_claim.py | 10 +++---- plugins/modules/pnp_device_claim_to_site.py | 10 +++---- plugins/modules/pnp_device_config_preview.py | 10 +++---- plugins/modules/pnp_device_count_info.py | 10 +++---- plugins/modules/pnp_device_history_info.py | 10 +++---- plugins/modules/pnp_device_import.py | 10 +++---- plugins/modules/pnp_device_info.py | 14 ++++++---- plugins/modules/pnp_device_reset.py | 10 +++---- plugins/modules/pnp_device_unclaim.py | 10 +++---- plugins/modules/pnp_global_settings.py | 10 +++---- plugins/modules/pnp_global_settings_info.py | 10 +++---- plugins/modules/pnp_server_profile_update.py | 10 +++---- .../modules/pnp_smart_account_domains_info.py | 10 +++---- plugins/modules/pnp_virtual_account_add.py | 12 +++++---- .../modules/pnp_virtual_account_deregister.py | 12 +++++---- .../pnp_virtual_account_devices_sync.py | 10 +++---- .../pnp_virtual_account_sync_result_info.py | 10 +++---- plugins/modules/pnp_virtual_accounts_info.py | 10 +++---- plugins/modules/pnp_workflow.py | 14 ++++++---- plugins/modules/pnp_workflow_count_info.py | 10 +++---- plugins/modules/pnp_workflow_info.py | 14 ++++++---- plugins/modules/profiling_rules_count_info.py | 11 ++++---- .../modules/profiling_rules_in_bulk_create.py | 12 +++++---- plugins/modules/projects_details_info.py | 10 +++---- plugins/modules/qos_device_interface.py | 19 ++++++++----- plugins/modules/qos_device_interface_info.py | 12 ++++----- .../qos_device_interface_info_count_info.py | 10 +++---- plugins/modules/reports.py | 13 +++++---- plugins/modules/reports_executions_info.py | 14 ++++++---- plugins/modules/reports_info.py | 13 +++++---- plugins/modules/reports_view_group_info.py | 14 ++++++---- .../modules/reports_view_group_view_info.py | 11 ++++---- plugins/modules/reserve_ip_subpool.py | 15 +++++++---- plugins/modules/reserve_ip_subpool_create.py | 9 +++---- plugins/modules/reserve_ip_subpool_delete.py | 9 +++---- plugins/modules/reserve_ip_subpool_info.py | 10 +++---- plugins/modules/reserve_ip_subpool_update.py | 9 +++---- plugins/modules/sda_count_info.py | 10 +++---- plugins/modules/sda_device_info.py | 10 +++---- plugins/modules/sda_device_role_info.py | 10 +++---- plugins/modules/sda_fabric.py | 12 +++++---- .../sda_fabric_authentication_profile.py | 15 +++++++---- .../sda_fabric_authentication_profile_info.py | 10 +++---- plugins/modules/sda_fabric_border_device.py | 12 +++++---- .../modules/sda_fabric_border_device_info.py | 10 +++---- .../sda_fabric_control_plane_device.py | 12 +++++---- .../sda_fabric_control_plane_device_info.py | 10 +++---- plugins/modules/sda_fabric_edge_device.py | 12 +++++---- .../modules/sda_fabric_edge_device_info.py | 10 +++---- plugins/modules/sda_fabric_info.py | 10 +++---- plugins/modules/sda_fabric_site.py | 12 +++++---- plugins/modules/sda_fabric_site_info.py | 10 +++---- plugins/modules/sda_multicast.py | 12 +++++---- plugins/modules/sda_multicast_info.py | 10 +++---- .../sda_port_assignment_for_access_point.py | 12 +++++---- ...a_port_assignment_for_access_point_info.py | 10 +++---- .../sda_port_assignment_for_user_device.py | 12 +++++---- ...da_port_assignment_for_user_device_info.py | 10 +++---- plugins/modules/sda_provision_device.py | 15 +++++++---- plugins/modules/sda_provision_device_info.py | 10 +++---- plugins/modules/sda_virtual_network.py | 12 +++++---- plugins/modules/sda_virtual_network_info.py | 10 +++---- .../modules/sda_virtual_network_ip_pool.py | 12 +++++---- .../sda_virtual_network_ip_pool_info.py | 10 +++---- plugins/modules/sda_virtual_network_v2.py | 15 +++++++---- .../modules/sda_virtual_network_v2_info.py | 10 +++---- .../security_advisories_devices_info.py | 10 +++---- ...security_advisories_ids_per_device_info.py | 10 +++---- plugins/modules/security_advisories_info.py | 10 +++---- .../security_advisories_per_device_info.py | 10 +++---- .../security_advisories_summary_info.py | 10 +++---- plugins/modules/sensor.py | 13 +++++---- plugins/modules/sensor_info.py | 10 +++---- plugins/modules/sensor_test_run.py | 10 +++---- .../modules/sensor_test_template_duplicate.py | 10 +++---- plugins/modules/sensor_test_template_edit.py | 10 +++---- plugins/modules/service_provider_create.py | 10 +++---- plugins/modules/service_provider_info.py | 10 +++---- .../service_provider_profile_delete.py | 10 +++---- plugins/modules/service_provider_update.py | 10 +++---- plugins/modules/site_assign_credential.py | 10 +++---- plugins/modules/site_assign_device.py | 10 +++---- plugins/modules/site_count_info.py | 10 +++---- plugins/modules/site_create.py | 10 +++---- plugins/modules/site_delete.py | 10 +++---- plugins/modules/site_design_floormap.py | 14 ++++++---- plugins/modules/site_design_floormap_info.py | 27 +++++++++++++++---- plugins/modules/site_health_info.py | 10 +++---- plugins/modules/site_info.py | 10 +++---- plugins/modules/site_membership_info.py | 10 +++---- plugins/modules/site_update.py | 10 +++---- plugins/modules/snmp_properties.py | 10 +++---- plugins/modules/snmp_properties_info.py | 10 +++---- .../snmpv2_read_community_credential.py | 13 +++++---- .../snmpv2_write_community_credential.py | 13 +++++---- plugins/modules/snmpv3_credential.py | 13 +++++---- plugins/modules/swim_image_details_info.py | 10 +++---- plugins/modules/swim_import_local.py | 11 ++++---- plugins/modules/swim_import_via_url.py | 11 ++++---- plugins/modules/swim_trigger_activation.py | 10 +++---- plugins/modules/swim_trigger_distribution.py | 10 +++---- plugins/modules/system_health_count_info.py | 10 +++---- plugins/modules/system_health_info.py | 10 +++---- .../system_performance_historical_info.py | 10 +++---- plugins/modules/system_performance_info.py | 10 +++---- plugins/modules/tag.py | 16 +++++++---- plugins/modules/tag_count_info.py | 10 +++---- plugins/modules/tag_info.py | 13 +++++---- plugins/modules/tag_member.py | 13 +++++---- plugins/modules/tag_member_count_info.py | 10 +++---- plugins/modules/tag_member_info.py | 10 +++---- plugins/modules/tag_member_type_info.py | 10 +++---- plugins/modules/tag_membership.py | 12 +++++---- plugins/modules/task_count_info.py | 10 +++---- plugins/modules/task_info.py | 13 +++++---- plugins/modules/task_operation_info.py | 10 +++---- plugins/modules/task_tree_info.py | 10 +++---- plugins/modules/template_preview.py | 10 +++---- plugins/modules/templates_details_info.py | 10 +++---- plugins/modules/threat_detail.py | 10 +++---- plugins/modules/threat_detail_count.py | 10 +++---- plugins/modules/threat_summary.py | 10 +++---- plugins/modules/topology_layer_2_info.py | 10 +++---- plugins/modules/topology_layer_3_info.py | 10 +++---- .../modules/topology_network_health_info.py | 10 +++---- plugins/modules/topology_physical_info.py | 10 +++---- plugins/modules/topology_site_info.py | 10 +++---- plugins/modules/topology_vlan_details_info.py | 10 +++---- .../modules/user_enrichment_details_info.py | 11 ++++---- plugins/modules/wireless_dynamic_interface.py | 13 +++++---- .../wireless_dynamic_interface_info.py | 10 +++---- plugins/modules/wireless_enterprise_ssid.py | 16 +++++++---- .../modules/wireless_enterprise_ssid_info.py | 10 +++---- plugins/modules/wireless_profile.py | 16 +++++++---- plugins/modules/wireless_profile_info.py | 10 +++---- .../wireless_provision_access_point.py | 10 +++---- .../wireless_provision_device_create.py | 10 +++---- .../wireless_provision_device_update.py | 10 +++---- ...ireless_provision_ssid_create_provision.py | 10 +++---- ...eless_provision_ssid_delete_reprovision.py | 10 +++---- plugins/modules/wireless_psk_override.py | 10 +++---- plugins/modules/wireless_rf_profile.py | 13 +++++---- plugins/modules/wireless_rf_profile_info.py | 10 +++---- .../wireless_sensor_test_results_info.py | 10 +++---- 327 files changed, 1948 insertions(+), 1628 deletions(-) diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 74ce8a3183..109beac320 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -366,3 +366,11 @@ releases: - wireless_enterprise_ssid - fix get_object_by_id (issue 32), which helps deletion. - wireless_profile - fix get_object_by_id (issue 32), which helps deletion. - wireless_rf_profile - fix get_object_by_id (issue 32), which helps deletion. + 4.1.2: + release_date: '2022-01-17' + changes: + release_summary: + bugfixes: + - plugin/modules/* - Update plugin module documentation + minor_changes: + - site_design_floormap_info - Add get_all to module \ No newline at end of file diff --git a/galaxy.yml b/galaxy.yml index 5cd428d7d9..a8c2b242f4 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,7 +1,7 @@ --- namespace: cisco name: dnac -version: 4.1.1 +version: 4.1.2 readme: README.md authors: - Rafael Campos diff --git a/plugins/action/site_design_floormap_info.py b/plugins/action/site_design_floormap_info.py index 82f2e513be..d31f05b9bf 100644 --- a/plugins/action/site_design_floormap_info.py +++ b/plugins/action/site_design_floormap_info.py @@ -90,9 +90,11 @@ def run(self, tmp=None, task_vars=None): self._result.update(dnac.exit_json()) return self._result if not id: - # NOTICE: Does not have a get all method or it is in another action - response = None - dnac.object_modify_result(changed=False, result="Module does not have get all, check arguments of module") + response = dnac.exec( + family="site_design", + function='get_floormaps', + params=self.get_object(self._task.args), + ) self._result.update(dict(dnac_response=response)) self._result.update(dnac.exit_json()) return self._result diff --git a/plugins/modules/app_policy_default_info.py b/plugins/modules/app_policy_default_info.py index ab95e84147..cdd9ff666e 100644 --- a/plugins/modules/app_policy_default_info.py +++ b/plugins/modules/app_policy_default_info.py @@ -10,6 +10,7 @@ short_description: Information module for App Policy Default description: - Get all App Policy Default. +- Get default application policy. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: App Policy Default reference - description: Complete reference of the App Policy Default object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_application_policy_default + - Paths used are get /dna/intent/api/v1/app-policy-default """ EXAMPLES = r""" diff --git a/plugins/modules/app_policy_info.py b/plugins/modules/app_policy_info.py index e9cbe7f1da..952ab36e05 100644 --- a/plugins/modules/app_policy_info.py +++ b/plugins/modules/app_policy_info.py @@ -10,6 +10,7 @@ short_description: Information module for App Policy description: - Get all App Policy. +- Get all existing application policies. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: App Policy reference - description: Complete reference of the App Policy object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_application_policy + - Paths used are get /dna/intent/api/v1/app-policy """ EXAMPLES = r""" diff --git a/plugins/modules/app_policy_intent_create.py b/plugins/modules/app_policy_intent_create.py index b82fd397ef..fba1b8bded 100644 --- a/plugins/modules/app_policy_intent_create.py +++ b/plugins/modules/app_policy_intent_create.py @@ -10,6 +10,7 @@ short_description: Resource module for App Policy Intent Create description: - Manage operation create of the resource App Policy Intent Create. +- Create/Update/Delete application policy. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -217,11 +218,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: App Policy Intent Create reference - description: Complete reference of the App Policy Intent Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.application_policy_intent + - Paths used are post /dna/intent/api/v1/app-policy-intent """ EXAMPLES = r""" diff --git a/plugins/modules/app_policy_queuing_profile.py b/plugins/modules/app_policy_queuing_profile.py index ba3635fc4e..b8a0842ab9 100644 --- a/plugins/modules/app_policy_queuing_profile.py +++ b/plugins/modules/app_policy_queuing_profile.py @@ -10,6 +10,9 @@ short_description: Resource module for App Policy Queuing Profile description: - Manage operations create, update and delete of the resource App Policy Queuing Profile. +- Update existing custom application queuing profile. +- Create new custom application queuing profile. +- Delete existing custom application policy queuing profile by id. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -83,11 +86,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: App Policy Queuing Profile reference - description: Complete reference of the App Policy Queuing Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.create_application_policy_queuing_profile, + application_policy.ApplicationPolicy.update_application_policy_queuing_profile, + application_policy.ApplicationPolicy.delete_application_policy_queuing_profile + - Paths used are put /dna/intent/api/v1/app-policy-queuing-profile, + post /dna/intent/api/v1/app-policy-queuing-profile, + delete /dna/intent/api/v1/app-policy-queuing-profile/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/app_policy_queuing_profile_count_info.py b/plugins/modules/app_policy_queuing_profile_count_info.py index 8bf3eec211..dfface14ac 100644 --- a/plugins/modules/app_policy_queuing_profile_count_info.py +++ b/plugins/modules/app_policy_queuing_profile_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for App Policy Queuing Profile Count description: - Get all App Policy Queuing Profile Count. +- Get the number of all existing application policy queuing profile. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: App Policy Queuing Profile Count reference - description: Complete reference of the App Policy Queuing Profile Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_application_policy_queuing_profile_count + - Paths used are get /dna/intent/api/v1/app-policy-queuing-profile-count """ EXAMPLES = r""" diff --git a/plugins/modules/app_policy_queuing_profile_info.py b/plugins/modules/app_policy_queuing_profile_info.py index b931b8c0c2..2960dc45fe 100644 --- a/plugins/modules/app_policy_queuing_profile_info.py +++ b/plugins/modules/app_policy_queuing_profile_info.py @@ -10,6 +10,7 @@ short_description: Information module for App Policy Queuing Profile description: - Get all App Policy Queuing Profile. +- Get all or by name, existing application policy queuing profiles. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: App Policy Queuing Profile reference - description: Complete reference of the App Policy Queuing Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_application_policy_queuing_profile + - Paths used are get /dna/intent/api/v1/app-policy-queuing-profile """ EXAMPLES = r""" diff --git a/plugins/modules/application_sets.py b/plugins/modules/application_sets.py index 7b50659d40..2240f528c3 100644 --- a/plugins/modules/application_sets.py +++ b/plugins/modules/application_sets.py @@ -10,6 +10,8 @@ short_description: Resource module for Application Sets description: - Manage operations create and delete of the resource Application Sets. +- Delete existing application-set by it's id. +- Create new custom application-set/s. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -28,11 +30,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Application Sets reference - description: Complete reference of the Application Sets object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.create_application_set + - Paths used are delete /dna/intent/api/v1/application-policy-application-set, + post /dna/intent/api/v1/application-policy-application-set """ EXAMPLES = r""" diff --git a/plugins/modules/application_sets_count_info.py b/plugins/modules/application_sets_count_info.py index f33073bab9..76bfa8840a 100644 --- a/plugins/modules/application_sets_count_info.py +++ b/plugins/modules/application_sets_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Application Sets Count description: - Get all Application Sets Count. +- Get the number of existing application-sets. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Application Sets Count reference - description: Complete reference of the Application Sets Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_application_sets_count + - Paths used are get /dna/intent/api/v1/application-policy-application-set-count """ EXAMPLES = r""" diff --git a/plugins/modules/application_sets_info.py b/plugins/modules/application_sets_info.py index edf139b740..88b8952c53 100644 --- a/plugins/modules/application_sets_info.py +++ b/plugins/modules/application_sets_info.py @@ -10,6 +10,7 @@ short_description: Information module for Application Sets description: - Get all Application Sets. +- Get appllication-sets by offset/limit or by name. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Application Sets reference - description: Complete reference of the Application Sets object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_application_sets + - Paths used are get /dna/intent/api/v1/application-policy-application-set """ EXAMPLES = r""" diff --git a/plugins/modules/applications.py b/plugins/modules/applications.py index 03802869d4..1a02b34caf 100644 --- a/plugins/modules/applications.py +++ b/plugins/modules/applications.py @@ -10,6 +10,9 @@ short_description: Resource module for Applications description: - Manage operations create, update and delete of the resource Applications. +- Create new Custom application. +- Edit the attributes of an existing application. +- Delete existing application by its id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -106,11 +109,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Applications reference - description: Complete reference of the Applications object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.edit_application + application_policy.ApplicationPolicy.create_application + - Paths used are post /dna/intent/api/v1/applications, + put /dna/intent/api/v1/applications, + delete /dna/intent/api/v1/applications """ EXAMPLES = r""" diff --git a/plugins/modules/applications_count_info.py b/plugins/modules/applications_count_info.py index 5642c1faf5..06f7c9aa1e 100644 --- a/plugins/modules/applications_count_info.py +++ b/plugins/modules/applications_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Applications Count description: - Get all Applications Count. +- Get the number of all existing applications. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Applications Count reference - description: Complete reference of the Applications Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_applications_count + - Paths used are get /dna/intent/api/v1/applications-count """ EXAMPLES = r""" diff --git a/plugins/modules/applications_health_info.py b/plugins/modules/applications_health_info.py index 48e5c027f1..e6ec6bb627 100644 --- a/plugins/modules/applications_health_info.py +++ b/plugins/modules/applications_health_info.py @@ -10,6 +10,8 @@ short_description: Information module for Applications Health description: - Get all Applications Health. +- Intent API to get a list of applications for a specific site, a device, or a client device's MAC address. + For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -64,11 +66,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Applications Health reference - description: Complete reference of the Applications Health object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + applications.Applications.applications + - Paths used are get /dna/intent/api/v1/application-health """ EXAMPLES = r""" diff --git a/plugins/modules/applications_info.py b/plugins/modules/applications_info.py index a98c94b733..2539b6e059 100644 --- a/plugins/modules/applications_info.py +++ b/plugins/modules/applications_info.py @@ -10,6 +10,7 @@ short_description: Information module for Applications description: - Get all Applications. +- Get applications by offset/limit or by name. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Applications reference - description: Complete reference of the Applications object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_applications + - Paths used are get /dna/intent/api/v1/applications """ EXAMPLES = r""" diff --git a/plugins/modules/associate_site_to_network_profile.py b/plugins/modules/associate_site_to_network_profile.py index 31298f8669..2d0d0352e4 100644 --- a/plugins/modules/associate_site_to_network_profile.py +++ b/plugins/modules/associate_site_to_network_profile.py @@ -10,6 +10,7 @@ short_description: Resource module for Associate Site To Network Profile description: - Manage operation create of the resource Associate Site To Network Profile. +- Associate Site to a Network Profile. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Associate Site To Network Profile reference - description: Complete reference of the Associate Site To Network Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.associate + site_design.SiteDesign.disassociate + - Paths used are post /dna/intent/api/v1/networkprofile/{networkProfileId}/site/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/authentication_import_certificate.py b/plugins/modules/authentication_import_certificate.py index 00651003ed..b8dc3172f9 100644 --- a/plugins/modules/authentication_import_certificate.py +++ b/plugins/modules/authentication_import_certificate.py @@ -10,6 +10,7 @@ short_description: Resource module for Authentication Import Certificate description: - Manage operation create of the resource Authentication Import Certificate. +- This method is used to upload a certificate. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -30,11 +31,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Authentication Import Certificate reference - description: Complete reference of the Authentication Import Certificate object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + authentication_management.AuthenticationManagement.import_certificate + - Paths used are post /dna/intent/api/v1/certificate """ EXAMPLES = r""" diff --git a/plugins/modules/authentication_import_certificate_p12.py b/plugins/modules/authentication_import_certificate_p12.py index 9cdc26aaf5..54a069346d 100644 --- a/plugins/modules/authentication_import_certificate_p12.py +++ b/plugins/modules/authentication_import_certificate_p12.py @@ -10,6 +10,7 @@ short_description: Resource module for Authentication Import Certificate P12 description: - Manage operation create of the resource Authentication Import Certificate P12. +- This method is used to upload a PKCS\#12 file. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -30,11 +31,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Authentication Import Certificate P12 reference - description: Complete reference of the Authentication Import Certificate P12 object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + authentication_management.AuthenticationManagement.import_certificate_p12 + - Paths used are post /dna/intent/api/v1/certificate-p12 """ EXAMPLES = r""" diff --git a/plugins/modules/business_sda_hostonboarding_ssid_ippool.py b/plugins/modules/business_sda_hostonboarding_ssid_ippool.py index c571526bde..19b55756f3 100644 --- a/plugins/modules/business_sda_hostonboarding_ssid_ippool.py +++ b/plugins/modules/business_sda_hostonboarding_ssid_ippool.py @@ -10,6 +10,8 @@ short_description: Resource module for Business Sda Hostonboarding Ssid Ippool description: - Manage operations create and update of the resource Business Sda Hostonboarding Ssid Ippool. +- Add SSID to IP Pool Mapping. +- Update SSID to IP Pool Mapping. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -31,11 +33,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Business Sda Hostonboarding Ssid Ippool reference - description: Complete reference of the Business Sda Hostonboarding Ssid Ippool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + fabric_wireless.FabricWireless.update_ssid_to_ip_pool_mapping, + fabric_wireless.FabricWireless.add_ssid_to_ip_pool_mapping + - Paths used are post /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool, + put /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool """ EXAMPLES = r""" diff --git a/plugins/modules/business_sda_hostonboarding_ssid_ippool_info.py b/plugins/modules/business_sda_hostonboarding_ssid_ippool_info.py index fb1a9158a4..142216725d 100644 --- a/plugins/modules/business_sda_hostonboarding_ssid_ippool_info.py +++ b/plugins/modules/business_sda_hostonboarding_ssid_ippool_info.py @@ -10,6 +10,7 @@ short_description: Information module for Business Sda Hostonboarding Ssid Ippool description: - Get all Business Sda Hostonboarding Ssid Ippool. +- Get SSID to IP Pool Mapping. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Business Sda Hostonboarding Ssid Ippool reference - description: Complete reference of the Business Sda Hostonboarding Ssid Ippool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + fabric_wireless.FabricWireless.get_ssid_to_ip_pool_mapping + - Paths used are get /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool """ EXAMPLES = r""" diff --git a/plugins/modules/business_sda_wireless_controller_create.py b/plugins/modules/business_sda_wireless_controller_create.py index 13becb785c..e203e5afd6 100644 --- a/plugins/modules/business_sda_wireless_controller_create.py +++ b/plugins/modules/business_sda_wireless_controller_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Business Sda Wireless Controller Create description: - Manage operation create of the resource Business Sda Wireless Controller Create. +- Add WLC to Fabric Domain. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Business Sda Wireless Controller Create reference - description: Complete reference of the Business Sda Wireless Controller Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + fabric_wireless.FabricWireless.add_w_l_c_to_fabric_domain + - Paths used are post /dna/intent/api/v1/business/sda/wireless-controller """ EXAMPLES = r""" diff --git a/plugins/modules/business_sda_wireless_controller_delete.py b/plugins/modules/business_sda_wireless_controller_delete.py index 105911a8a8..6319d6e2d9 100644 --- a/plugins/modules/business_sda_wireless_controller_delete.py +++ b/plugins/modules/business_sda_wireless_controller_delete.py @@ -10,6 +10,7 @@ short_description: Resource module for Business Sda Wireless Controller Delete description: - Manage operation delete of the resource Business Sda Wireless Controller Delete. +- Remove WLC from Fabric Domain. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Business Sda Wireless Controller Delete reference - description: Complete reference of the Business Sda Wireless Controller Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + fabric_wireless.FabricWireless.add_w_l_c_to_fabric_domain + - Paths used are delete /dna/intent/api/v1/business/sda/wireless-controller """ EXAMPLES = r""" diff --git a/plugins/modules/cli_credential.py b/plugins/modules/cli_credential.py index 734288daca..a2fa8943c3 100644 --- a/plugins/modules/cli_credential.py +++ b/plugins/modules/cli_credential.py @@ -10,6 +10,8 @@ short_description: Resource module for Cli Credential description: - Manage operations create and update of the resource Cli Credential. +- Updates global CLI credentials. +- Adds global CLI credential. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -45,11 +47,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Cli Credential reference - description: Complete reference of the Cli Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.update_cli_credentials, + discovery.Discovery.create_cli_credentials + - Paths used are put /dna/intent/api/v1/global-credential/cli, + post /dna/intent/api/v1/global-credential/cli """ EXAMPLES = r""" diff --git a/plugins/modules/client_detail_info.py b/plugins/modules/client_detail_info.py index 17bb07aed9..b8aeb45244 100644 --- a/plugins/modules/client_detail_info.py +++ b/plugins/modules/client_detail_info.py @@ -10,6 +10,7 @@ short_description: Information module for Client Detail description: - Get all Client Detail. +- Returns detailed Client information retrieved by Mac Address for any given point of time. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Client Detail reference - description: Complete reference of the Client Detail object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + clients.Clients.get_client_detail + - Paths used are get /dna/intent/api/v1/client-detail """ EXAMPLES = r""" diff --git a/plugins/modules/client_enrichment_details_info.py b/plugins/modules/client_enrichment_details_info.py index 0edea22a4c..acfd79a5eb 100644 --- a/plugins/modules/client_enrichment_details_info.py +++ b/plugins/modules/client_enrichment_details_info.py @@ -10,6 +10,9 @@ short_description: Information module for Client Enrichment Details description: - Get all Client Enrichment Details. +- Enriches a given network End User context a network user-id or end user's device Mac Address + with details about the user, the devices that the user is connected to and the assurance + issues that the user is impacted by. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +24,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Client Enrichment Details reference - description: Complete reference of the Client Enrichment Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + clients.Clients.get_client_enrichment_details + - Paths used are get /dna/intent/api/v1/client-enrichment-details """ EXAMPLES = r""" diff --git a/plugins/modules/client_health_info.py b/plugins/modules/client_health_info.py index 8e92888020..50dc8d02e4 100644 --- a/plugins/modules/client_health_info.py +++ b/plugins/modules/client_health_info.py @@ -10,6 +10,7 @@ short_description: Information module for Client Health description: - Get all Client Health. +- Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Client Health reference - description: Complete reference of the Client Health object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + clients.Clients.get_overall_client_health + - Paths used are get /dna/intent/api/v1/client-health """ EXAMPLES = r""" diff --git a/plugins/modules/client_proximity_info.py b/plugins/modules/client_proximity_info.py index b3d358dc66..0644b65539 100644 --- a/plugins/modules/client_proximity_info.py +++ b/plugins/modules/client_proximity_info.py @@ -10,6 +10,10 @@ short_description: Information module for Client Proximity description: - Get all Client Proximity. +- This intent API will provide client proximity information for a specific wireless user. + Proximity is defined as presence on the same floor at the same time as the specified wireless user. + The Proximity workflow requires the subscription to the following event via the Event Notification workflow prior to making this API call + NETWORK-CLIENTS-3-506 - Client Proximity Report. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -37,11 +41,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Client Proximity reference - description: Complete reference of the Client Proximity object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + clients.Clients.client_proximity + - Paths used are get /dna/intent/api/v1/client-proximity """ EXAMPLES = r""" diff --git a/plugins/modules/command_runner_run_command.py b/plugins/modules/command_runner_run_command.py index 46e7d3e9fc..8f231713f3 100644 --- a/plugins/modules/command_runner_run_command.py +++ b/plugins/modules/command_runner_run_command.py @@ -10,6 +10,7 @@ short_description: Resource module for Command Runner Run Command description: - Manage operation create of the resource Command Runner Run Command. +- Submit request for read-only CLIs. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -35,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Command Runner Run Command reference - description: Complete reference of the Command Runner Run Command object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + command_runner.CommandRunner.run_read_only_commands_on_devices + - Paths used are post /dna/intent/api/v1/network-device-poller/cli/read-request """ EXAMPLES = r""" diff --git a/plugins/modules/compliance_check_run.py b/plugins/modules/compliance_check_run.py index 1ceb1e11f3..a50a6106c2 100644 --- a/plugins/modules/compliance_check_run.py +++ b/plugins/modules/compliance_check_run.py @@ -10,6 +10,7 @@ short_description: Resource module for Compliance Check Run description: - Manage operation create of the resource Compliance Check Run. +- Run compliance check for device(s). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Compliance Check Run reference - description: Complete reference of the Compliance Check Run object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + compliance.Compliance.run_compliance + - Paths used are post /dna/intent/api/v1/compliance/ """ EXAMPLES = r""" diff --git a/plugins/modules/compliance_device_by_id_info.py b/plugins/modules/compliance_device_by_id_info.py index f24afbf94c..6019309728 100644 --- a/plugins/modules/compliance_device_by_id_info.py +++ b/plugins/modules/compliance_device_by_id_info.py @@ -10,6 +10,7 @@ short_description: Information module for Compliance Device By Id description: - Get all Compliance Device By Id. +- Return compliance detailed report for a device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -47,11 +48,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Compliance Device By Id reference - description: Complete reference of the Compliance Device By Id object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + compliance.Compliance.compliance_details_of_device + - Paths used are get /dna/intent/api/v1/compliance/{deviceUuid}/detail """ EXAMPLES = r""" diff --git a/plugins/modules/compliance_device_details_count_info.py b/plugins/modules/compliance_device_details_count_info.py index 6dc3ff6b70..146051992a 100644 --- a/plugins/modules/compliance_device_details_count_info.py +++ b/plugins/modules/compliance_device_details_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Compliance Device Details Count description: - Get all Compliance Device Details Count. +- Return Compliance Count Detail. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Compliance Device Details Count reference - description: Complete reference of the Compliance Device Details Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + compliance.Compliance.get_compliance_detail_count + - Paths used are get /dna/intent/api/v1/compliance/detail/count """ EXAMPLES = r""" diff --git a/plugins/modules/compliance_device_details_info.py b/plugins/modules/compliance_device_details_info.py index 2b3c07e137..fa465ec43c 100644 --- a/plugins/modules/compliance_device_details_info.py +++ b/plugins/modules/compliance_device_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Compliance Device Details description: - Get all Compliance Device Details. +- Return Compliance Detail. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -45,11 +46,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Compliance Device Details reference - description: Complete reference of the Compliance Device Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + compliance.Compliance.get_compliance_detail + - Paths used are get /dna/intent/api/v1/compliance/detail """ EXAMPLES = r""" diff --git a/plugins/modules/compliance_device_info.py b/plugins/modules/compliance_device_info.py index 438eb88c16..4fdfcd42cf 100644 --- a/plugins/modules/compliance_device_info.py +++ b/plugins/modules/compliance_device_info.py @@ -11,6 +11,8 @@ description: - Get all Compliance Device. - Get Compliance Device by id. +- Return compliance status of device(s). +- Return compliance status of a device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -40,11 +42,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Compliance Device reference - description: Complete reference of the Compliance Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + compliance.Compliance.get_compliance_status, + compliance.Compliance.device_compliance_status + - Paths used are get /dna/intent/api/v1/compliance, + get /dna/intent/api/v1/compliance/{deviceUuid} """ EXAMPLES = r""" diff --git a/plugins/modules/compliance_device_status_count_info.py b/plugins/modules/compliance_device_status_count_info.py index 1bb5094687..e76caeac6b 100644 --- a/plugins/modules/compliance_device_status_count_info.py +++ b/plugins/modules/compliance_device_status_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Compliance Device Status Count description: - Get all Compliance Device Status Count. +- Return Compliance Status Count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Compliance Device Status Count reference - description: Complete reference of the Compliance Device Status Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + compliance.Compliance.get_compliance_status_count + - Paths used are get /dna/intent/api/v1/compliance/count """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template.py b/plugins/modules/configuration_template.py index 686514be0f..5585f2e46e 100644 --- a/plugins/modules/configuration_template.py +++ b/plugins/modules/configuration_template.py @@ -10,6 +10,8 @@ short_description: Resource module for Configuration Template description: - Manage operations update and delete of the resource Configuration Template. +- API to update a template. +- Deletes the template by its id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -501,11 +503,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template reference - description: Complete reference of the Configuration Template object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.update_template, + configuration_templates.ConfigurationTemplates.deletes_the_template + - Paths used are put /dna/intent/api/v1/template-programmer/template, + delete /dna/intent/api/v1/template-programmer/template/{templateId} """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_clone.py b/plugins/modules/configuration_template_clone.py index 242a42eb64..329939203a 100644 --- a/plugins/modules/configuration_template_clone.py +++ b/plugins/modules/configuration_template_clone.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Clone description: - Manage operation create of the resource Configuration Template Clone. +- API to clone template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Clone reference - description: Complete reference of the Configuration Template Clone object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.clone_given_template + - Paths used are post /dna/intent/api/v1/template-programmer/clone/name/{name}/project/{projectId}/template/{templateId} """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_create.py b/plugins/modules/configuration_template_create.py index 7cf1f7eed0..c9283b6b30 100644 --- a/plugins/modules/configuration_template_create.py +++ b/plugins/modules/configuration_template_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Create description: - Manage operation create of the resource Configuration Template Create. +- API to create a template by project id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -498,11 +499,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Create reference - description: Complete reference of the Configuration Template Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.create_template + - Paths used are post /dna/intent/api/v1/template-programmer/project/{projectId}/template """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_deploy.py b/plugins/modules/configuration_template_deploy.py index 358bacd498..0db3d7b0d5 100644 --- a/plugins/modules/configuration_template_deploy.py +++ b/plugins/modules/configuration_template_deploy.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Deploy description: - Manage operation create of the resource Configuration Template Deploy. +- API to deploy a template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -57,11 +58,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Deploy reference - description: Complete reference of the Configuration Template Deploy object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.deploy_template + - Paths used are post /dna/intent/api/v1/template-programmer/template/deploy """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_deploy_status_info.py b/plugins/modules/configuration_template_deploy_status_info.py index 6001d86b06..b068224c0a 100644 --- a/plugins/modules/configuration_template_deploy_status_info.py +++ b/plugins/modules/configuration_template_deploy_status_info.py @@ -10,6 +10,7 @@ short_description: Information module for Configuration Template Deploy Status description: - Get Configuration Template Deploy Status by id. +- API to retrieve the status of template deployment. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Deploy Status reference - description: Complete reference of the Configuration Template Deploy Status object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.get_template_deployment_status + - Paths used are get /dna/intent/api/v1/template-programmer/template/deploy/status/{deploymentId} """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_deploy_v2.py b/plugins/modules/configuration_template_deploy_v2.py index 48be1d71c1..20c5f75f7a 100644 --- a/plugins/modules/configuration_template_deploy_v2.py +++ b/plugins/modules/configuration_template_deploy_v2.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Deploy V2 description: - Manage operation create of the resource Configuration Template Deploy V2. +- V2 API to deploy a template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -57,11 +58,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Deploy V2 reference - description: Complete reference of the Configuration Template Deploy V2 object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.deploy_template_v2 + - Paths used are post /dna/intent/api/v2/template-programmer/template/deploy """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_export_project.py b/plugins/modules/configuration_template_export_project.py index 9f69a66c10..c1c4301d70 100644 --- a/plugins/modules/configuration_template_export_project.py +++ b/plugins/modules/configuration_template_export_project.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Export Project description: - Manage operation create of the resource Configuration Template Export Project. +- Exports the projects for given projectNames. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -22,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Export Project reference - description: Complete reference of the Configuration Template Export Project object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.export_projects + - Paths used are post /dna/intent/api/v1/template-programmer/project/name/exportprojects """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_export_template.py b/plugins/modules/configuration_template_export_template.py index 8baaa0d86e..1ac747de21 100644 --- a/plugins/modules/configuration_template_export_template.py +++ b/plugins/modules/configuration_template_export_template.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Export Template description: - Manage operation create of the resource Configuration Template Export Template. +- Exports the templates for given templateIds. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -22,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Export Template reference - description: Complete reference of the Configuration Template Export Template object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.export_templates + - Paths used are post /dna/intent/api/v1/template-programmer/template/exporttemplates """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_import_project.py b/plugins/modules/configuration_template_import_project.py index da3292c0c4..1a3169ef93 100644 --- a/plugins/modules/configuration_template_import_project.py +++ b/plugins/modules/configuration_template_import_project.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Import Project description: - Manage operation create of the resource Configuration Template Import Project. +- Imports the Projects provided in the DTO. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Import Project reference - description: Complete reference of the Configuration Template Import Project object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.imports_the_projects_provided + - Paths used are post /dna/intent/api/v1/template-programmer/project/importprojects """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_import_template.py b/plugins/modules/configuration_template_import_template.py index 50125d4156..fd29370018 100644 --- a/plugins/modules/configuration_template_import_template.py +++ b/plugins/modules/configuration_template_import_template.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Import Template description: - Manage operation create of the resource Configuration Template Import Template. +- Imports the templates provided in the DTO by project Name. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -512,11 +513,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Import Template reference - description: Complete reference of the Configuration Template Import Template object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.imports_the_templates_provided + - Paths used are post /dna/intent/api/v1/template-programmer/project/name/{projectName}/template/importtemplates """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_info.py b/plugins/modules/configuration_template_info.py index 88c94fabcb..9f7e468907 100644 --- a/plugins/modules/configuration_template_info.py +++ b/plugins/modules/configuration_template_info.py @@ -11,6 +11,8 @@ description: - Get all Configuration Template. - Get Configuration Template by id. +- List the templates available +- Details of the template by its id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -74,11 +76,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template reference - description: Complete reference of the Configuration Template object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.get_template_details, + configuration_templates.ConfigurationTemplates.gets_the_templates_available + - Paths used are get /dna/intent/api/v1/template-programmer/template, + get /dna/intent/api/v1/template-programmer/template/{templateId} """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_project.py b/plugins/modules/configuration_template_project.py index a92ae8c50b..18b86c9d8e 100644 --- a/plugins/modules/configuration_template_project.py +++ b/plugins/modules/configuration_template_project.py @@ -10,6 +10,9 @@ short_description: Resource module for Configuration Template Project description: - Manage operations create, update and delete of the resource Configuration Template Project. +- This API is used to create a new project. +- This API is used to update an existing project. +- Deletes the project by its id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -536,11 +539,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Project reference - description: Complete reference of the Configuration Template Project object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.update_project, + configuration_templates.ConfigurationTemplates.deletes_the_project, + configuration_templates.ConfigurationTemplates.create_project + - Paths used are post /dna/intent/api/v1/template-programmer/project, + put /dna/intent/api/v1/template-programmer/project, + delete /dna/intent/api/v1/template-programmer/project/{projectId} """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_project_info.py b/plugins/modules/configuration_template_project_info.py index 28d17918bf..ee3223bc88 100644 --- a/plugins/modules/configuration_template_project_info.py +++ b/plugins/modules/configuration_template_project_info.py @@ -11,6 +11,8 @@ description: - Get all Configuration Template Project. - Get Configuration Template Project by id. +- List the projects. +- Get the details of the given project by its id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -34,11 +36,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Project reference - description: Complete reference of the Configuration Template Project object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.get_projects, + configuration_templates.ConfigurationTemplates.get_project_details + - Paths used are get /dna/intent/api/v1/template-programmer/project, + get /dna/intent/api/v1/template-programmer/project/{projectId} """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_version_create.py b/plugins/modules/configuration_template_version_create.py index abff52677b..9da65718ab 100644 --- a/plugins/modules/configuration_template_version_create.py +++ b/plugins/modules/configuration_template_version_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Configuration Template Version Create description: - Manage operation create of the resource Configuration Template Version Create. +- API to version the current contents of the template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Version Create reference - description: Complete reference of the Configuration Template Version Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.version_template + - Paths used are post /dna/intent/api/v1/template-programmer/template/version """ EXAMPLES = r""" diff --git a/plugins/modules/configuration_template_version_info.py b/plugins/modules/configuration_template_version_info.py index 68cf75fdcf..ee42a9dc68 100644 --- a/plugins/modules/configuration_template_version_info.py +++ b/plugins/modules/configuration_template_version_info.py @@ -10,6 +10,7 @@ short_description: Information module for Configuration Template Version description: - Get Configuration Template Version by id. +- Get all the versions of template by its id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Configuration Template Version reference - description: Complete reference of the Configuration Template Version object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.get_template_versions + - Paths used are get /dna/intent/api/v1/template-programmer/template/version/{templateId} """ EXAMPLES = r""" diff --git a/plugins/modules/device_configurations_export.py b/plugins/modules/device_configurations_export.py index 6159dc1b7a..bd10c6d8c7 100644 --- a/plugins/modules/device_configurations_export.py +++ b/plugins/modules/device_configurations_export.py @@ -10,6 +10,7 @@ short_description: Resource module for Device Configurations Export description: - Manage operation create of the resource Device Configurations Export. +- Export Device configurations to an encrypted zip file. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Configurations Export reference - description: Complete reference of the Device Configurations Export object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_archive.ConfigurationArchive.export_device_configurations + - Paths used are post /dna/intent/api/v1/network-device-archive/cleartext """ EXAMPLES = r""" diff --git a/plugins/modules/device_credential_create.py b/plugins/modules/device_credential_create.py index b46bb653fc..55e30006ee 100644 --- a/plugins/modules/device_credential_create.py +++ b/plugins/modules/device_credential_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Device Credential Create description: - Manage operation create of the resource Device Credential Create. +- API to create device credentials. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -115,11 +116,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Credential Create reference - description: Complete reference of the Device Credential Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.update_device_credentials, + network_settings.NetworkSettings.create_device_credentials + - Paths used are post /dna/intent/api/v1/device-credential """ EXAMPLES = r""" diff --git a/plugins/modules/device_credential_delete.py b/plugins/modules/device_credential_delete.py index 6a1c2208f3..ad93fcf5e4 100644 --- a/plugins/modules/device_credential_delete.py +++ b/plugins/modules/device_credential_delete.py @@ -10,6 +10,7 @@ short_description: Resource module for Device Credential Delete description: - Manage operation delete of the resource Device Credential Delete. +- Delete device credential. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Credential Delete reference - description: Complete reference of the Device Credential Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.delete_device_credential + - Paths used are delete /dna/intent/api/v1/device-credential/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/device_credential_info.py b/plugins/modules/device_credential_info.py index 977fde5d25..b4450e9138 100644 --- a/plugins/modules/device_credential_info.py +++ b/plugins/modules/device_credential_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Credential description: - Get all Device Credential. +- API to get device credential details. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Credential reference - description: Complete reference of the Device Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.get_device_credential_details + - Paths used are get /dna/intent/api/v1/device-credential """ EXAMPLES = r""" diff --git a/plugins/modules/device_credential_update.py b/plugins/modules/device_credential_update.py index 8eab526638..31e3baef12 100644 --- a/plugins/modules/device_credential_update.py +++ b/plugins/modules/device_credential_update.py @@ -10,6 +10,7 @@ short_description: Resource module for Device Credential Update description: - Manage operation update of the resource Device Credential Update. +- API to update device credentials. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -115,11 +116,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Credential Update reference - description: Complete reference of the Device Credential Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.update_device_credentials, + network_settings.NetworkSettings.create_device_credentials + - Paths used are put /dna/intent/api/v1/device-credential """ EXAMPLES = r""" diff --git a/plugins/modules/device_details_info.py b/plugins/modules/device_details_info.py index 46e114e1b4..beac01425f 100644 --- a/plugins/modules/device_details_info.py +++ b/plugins/modules/device_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Details description: - Get all Device Details. +- Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Details reference - description: Complete reference of the Device Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_detail + - Paths used are get /dna/intent/api/v1/device-detail """ EXAMPLES = r""" diff --git a/plugins/modules/device_enrichment_details_info.py b/plugins/modules/device_enrichment_details_info.py index 4641cd6171..e4abc41915 100644 --- a/plugins/modules/device_enrichment_details_info.py +++ b/plugins/modules/device_enrichment_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Enrichment Details description: - Get all Device Enrichment Details. +- Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Enrichment Details reference - description: Complete reference of the Device Enrichment Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_enrichment_details + - Paths used are get /dna/intent/api/v1/device-enrichment-details """ EXAMPLES = r""" diff --git a/plugins/modules/device_family_identifiers_details_info.py b/plugins/modules/device_family_identifiers_details_info.py index 7e4a08814a..ead9035216 100644 --- a/plugins/modules/device_family_identifiers_details_info.py +++ b/plugins/modules/device_family_identifiers_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Family Identifiers Details description: - Get all Device Family Identifiers Details. +- API to get Device Family Identifiers for all Device Families that can be used for tagging an image golden. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Family Identifiers Details reference - description: Complete reference of the Device Family Identifiers Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.get_device_family_identifiers + - Paths used are get /dna/intent/api/v1/image/importation/device-family-identifiers """ EXAMPLES = r""" diff --git a/plugins/modules/device_health_info.py b/plugins/modules/device_health_info.py index 64094ac484..6096899ca5 100644 --- a/plugins/modules/device_health_info.py +++ b/plugins/modules/device_health_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Health description: - Get all Device Health. +- Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -49,11 +50,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Health reference - description: Complete reference of the Device Health object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.devices + - Paths used are get /dna/intent/api/v1/device-health """ EXAMPLES = r""" diff --git a/plugins/modules/device_interface_by_ip_info.py b/plugins/modules/device_interface_by_ip_info.py index 3508fe5a2e..4a2d29bd3b 100644 --- a/plugins/modules/device_interface_by_ip_info.py +++ b/plugins/modules/device_interface_by_ip_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Interface By Ip description: - Get Device Interface By Ip by id. +- Returns list of interfaces for specified device management IP address. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Interface By Ip reference - description: Complete reference of the Device Interface By Ip object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_interface_by_ip + - Paths used are get /dna/intent/api/v1/interface/ip-address/{ipAddress} """ EXAMPLES = r""" diff --git a/plugins/modules/device_interface_count_info.py b/plugins/modules/device_interface_count_info.py index 9828f39964..84b20c1dca 100644 --- a/plugins/modules/device_interface_count_info.py +++ b/plugins/modules/device_interface_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Interface Count description: - Get all Device Interface Count. +- Returns the count of interfaces for all devices. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Interface Count reference - description: Complete reference of the Device Interface Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_interface_count + - Paths used are get /dna/intent/api/v1/interface/count """ EXAMPLES = r""" diff --git a/plugins/modules/device_interface_info.py b/plugins/modules/device_interface_info.py index 996c3d488b..b708158495 100644 --- a/plugins/modules/device_interface_info.py +++ b/plugins/modules/device_interface_info.py @@ -11,6 +11,8 @@ description: - Get all Device Interface. - Get Device Interface by id. +- Returns all available interfaces. This endpoint can return a maximum of 500 interfaces. +- Returns the interface for the given interface ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -34,11 +36,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Interface reference - description: Complete reference of the Device Interface object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_interface_by_id, + devices.Devices.get_all_interfaces + - Paths used are get /dna/intent/api/v1/interface, + get /dna/intent/api/v1/interface/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/device_interface_isis_info.py b/plugins/modules/device_interface_isis_info.py index c2b55b404b..d076068a25 100644 --- a/plugins/modules/device_interface_isis_info.py +++ b/plugins/modules/device_interface_isis_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Interface Isis description: - Get all Device Interface Isis. +- Returns the interfaces that has ISIS enabled. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Interface Isis reference - description: Complete reference of the Device Interface Isis object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_isis_interfaces + - Paths used are get /dna/intent/api/v1/interface/isis """ EXAMPLES = r""" diff --git a/plugins/modules/device_interface_ospf_info.py b/plugins/modules/device_interface_ospf_info.py index f34ac461cd..8283861dd6 100644 --- a/plugins/modules/device_interface_ospf_info.py +++ b/plugins/modules/device_interface_ospf_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Interface Ospf description: - Get all Device Interface Ospf. +- Returns the interfaces that has OSPF enabled. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Interface Ospf reference - description: Complete reference of the Device Interface Ospf object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_ospf_interfaces + - Paths used are get /dna/intent/api/v1/interface/ospf """ EXAMPLES = r""" diff --git a/plugins/modules/device_replacement.py b/plugins/modules/device_replacement.py index 95723b15a3..04c1e58f40 100644 --- a/plugins/modules/device_replacement.py +++ b/plugins/modules/device_replacement.py @@ -10,6 +10,8 @@ short_description: Resource module for Device Replacement description: - Manage operations create and update of the resource Device Replacement. +- UnMarks device for replacement. +- Marks device for replacement. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -64,11 +66,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Replacement reference - description: Complete reference of the Device Replacement object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_replacement.DeviceReplacement.mark_device_for_replacement, + device_replacement.DeviceReplacement.unmark_device_for_replacement + - Paths used are put /dna/intent/api/v1/device-replacement, + post /dna/intent/api/v1/device-replacement """ EXAMPLES = r""" diff --git a/plugins/modules/device_replacement_count_info.py b/plugins/modules/device_replacement_count_info.py index 0a62c451b1..f3976c0d47 100644 --- a/plugins/modules/device_replacement_count_info.py +++ b/plugins/modules/device_replacement_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Device Replacement Count description: - Get all Device Replacement Count. +- Get replacement devices count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Replacement Count reference - description: Complete reference of the Device Replacement Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_replacement.DeviceReplacement.return_replacement_devices_count + - Paths used are get /dna/intent/api/v1/device-replacement/count """ EXAMPLES = r""" diff --git a/plugins/modules/device_replacement_deploy.py b/plugins/modules/device_replacement_deploy.py index 0f98c402ff..12f6ee61fc 100644 --- a/plugins/modules/device_replacement_deploy.py +++ b/plugins/modules/device_replacement_deploy.py @@ -10,6 +10,7 @@ short_description: Resource module for Device Replacement Deploy description: - Manage operation create of the resource Device Replacement Deploy. +- API to trigger RMA workflow that will replace faulty device with replacement device with same configuration and images. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Replacement Deploy reference - description: Complete reference of the Device Replacement Deploy object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_replacement.DeviceReplacement.deploy_device_replacement_workflow + - Paths used are post /dna/intent/api/v1/device-replacement/workflow """ EXAMPLES = r""" diff --git a/plugins/modules/device_replacement_info.py b/plugins/modules/device_replacement_info.py index b2f7e2fcbf..a00a6d34e9 100644 --- a/plugins/modules/device_replacement_info.py +++ b/plugins/modules/device_replacement_info.py @@ -10,6 +10,9 @@ short_description: Information module for Device Replacement description: - Get all Device Replacement. +- Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name, + Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number, + Replacement Device Serial Number, Device Replacement status, Product Family. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -67,11 +70,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Device Replacement reference - description: Complete reference of the Device Replacement object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_replacement.DeviceReplacement.return_replacement_devices_with_details + - Paths used are get /dna/intent/api/v1/device-replacement """ EXAMPLES = r""" diff --git a/plugins/modules/disassociate_site_to_network_profile.py b/plugins/modules/disassociate_site_to_network_profile.py index ad299fcd4b..b61356024c 100644 --- a/plugins/modules/disassociate_site_to_network_profile.py +++ b/plugins/modules/disassociate_site_to_network_profile.py @@ -10,6 +10,7 @@ short_description: Resource module for Disassociate Site To Network Profile description: - Manage operation delete of the resource Disassociate Site To Network Profile. +- Disassociate a Site from a Network Profile. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Disassociate Site To Network Profile reference - description: Complete reference of the Disassociate Site To Network Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.associate, + site_design.SiteDesign.disassociate + - Paths used are delete /dna/intent/api/v1/networkprofile/{networkProfileId}/site/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/disasterrecovery_system_operationstatus_info.py b/plugins/modules/disasterrecovery_system_operationstatus_info.py index bbe53a7602..6f1756ff91 100644 --- a/plugins/modules/disasterrecovery_system_operationstatus_info.py +++ b/plugins/modules/disasterrecovery_system_operationstatus_info.py @@ -10,6 +10,7 @@ short_description: Information module for Disasterrecovery System Operationstatus description: - Get all Disasterrecovery System Operationstatus. +- Returns the status of Disaster Recovery operation performed on the system. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Disasterrecovery System Operationstatus reference - description: Complete reference of the Disasterrecovery System Operationstatus object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + disaster_recovery.DisasterRecovery.disaster_recovery_operational_status + - Paths used are get /dna/intent/api/v1/disasterrecovery/system/operationstatus """ EXAMPLES = r""" diff --git a/plugins/modules/disasterrecovery_system_status_info.py b/plugins/modules/disasterrecovery_system_status_info.py index 6ad5258fbc..49b624df9e 100644 --- a/plugins/modules/disasterrecovery_system_status_info.py +++ b/plugins/modules/disasterrecovery_system_status_info.py @@ -10,6 +10,7 @@ short_description: Information module for Disasterrecovery System Status description: - Get all Disasterrecovery System Status. +- Detailed and Summarized status of DR components (Active, Standby and Witness system's health). version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Disasterrecovery System Status reference - description: Complete reference of the Disasterrecovery System Status object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + disaster_recovery.DisasterRecovery.disaster_recovery_status + - Paths used are get /dna/intent/api/v1/disasterrecovery/system/status """ EXAMPLES = r""" diff --git a/plugins/modules/discovery.py b/plugins/modules/discovery.py index d7994e68f0..9f84517320 100644 --- a/plugins/modules/discovery.py +++ b/plugins/modules/discovery.py @@ -10,6 +10,10 @@ short_description: Resource module for Discovery description: - Manage operations create, update and delete of the resource Discovery. +- Stops all the discoveries and removes them. +- Stops or starts an existing discovery. +- Initiates discovery with the given parameters. +- Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the "Get Discoveries by range" API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -210,11 +214,15 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery reference - description: Complete reference of the Discovery object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.start_discovery, + discovery.Discovery.updates_discovery_by_id, + discovery.Discovery.delete_discovery_by_id + - Paths used are delete /dna/intent/api/v1/discovery, + put /dna/intent/api/v1/discovery, + post /dna/intent/api/v1/discovery, + delete /dna/intent/api/v1/discovery/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_count_info.py b/plugins/modules/discovery_count_info.py index c5b4389609..59f9190ebb 100644 --- a/plugins/modules/discovery_count_info.py +++ b/plugins/modules/discovery_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Discovery Count description: - Get all Discovery Count. +- Returns the count of all available discovery jobs. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Count reference - description: Complete reference of the Discovery Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_count_of_all_discovery_jobs + - Paths used are get /dna/intent/api/v1/discovery/count """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_device_count_info.py b/plugins/modules/discovery_device_count_info.py index 8271fd4a3f..bca85389cc 100644 --- a/plugins/modules/discovery_device_count_info.py +++ b/plugins/modules/discovery_device_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Discovery Device Count description: - Get all Discovery Device Count. +- Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the "Get Discoveries by range" API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Device Count reference - description: Complete reference of the Discovery Device Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_devices_discovered_by_id + - Paths used are get /dna/intent/api/v1/discovery/{id}/network-device/count """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_device_info.py b/plugins/modules/discovery_device_info.py index 1952e73062..29e0771930 100644 --- a/plugins/modules/discovery_device_info.py +++ b/plugins/modules/discovery_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Discovery Device description: - Get all Discovery Device. +- Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Device reference - description: Complete reference of the Discovery Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_discovered_network_devices_by_discovery_id + - Paths used are get /dna/intent/api/v1/discovery/{id}/network-device """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_device_range_info.py b/plugins/modules/discovery_device_range_info.py index 28c4ef28a0..f669481632 100644 --- a/plugins/modules/discovery_device_range_info.py +++ b/plugins/modules/discovery_device_range_info.py @@ -10,6 +10,9 @@ short_description: Information module for Discovery Device Range description: - Get all Discovery Device Range. +- Returns the network devices discovered for the given discovery and for the given range. + The maximum number of records that can be retrieved is 500. + Discovery ID can be obtained using the "Get Discoveries by range" API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -37,11 +40,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Device Range reference - description: Complete reference of the Discovery Device Range object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_discovered_devices_by_range + - Paths used are get /dna/intent/api/v1/discovery/{id}/network-device/{startIndex}/{recordsToReturn} """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_info.py b/plugins/modules/discovery_info.py index 7a2f10c06f..4499cc6572 100644 --- a/plugins/modules/discovery_info.py +++ b/plugins/modules/discovery_info.py @@ -10,6 +10,7 @@ short_description: Information module for Discovery description: - Get Discovery by id. +- Returns discovery by Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery reference - description: Complete reference of the Discovery object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_discovery_by_id + - Paths used are get /dna/intent/api/v1/discovery/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_job_info.py b/plugins/modules/discovery_job_info.py index 451d456e9c..304c11d786 100644 --- a/plugins/modules/discovery_job_info.py +++ b/plugins/modules/discovery_job_info.py @@ -11,6 +11,10 @@ description: - Get all Discovery Job. - Get Discovery Job by id. +- Returns the list of discovery jobs for the given IP. +- Returns the list of discovery jobs for the given Discovery ID. + The results can be optionally filtered based on IP. + Discovery ID can be obtained using the "Get Discoveries by range" API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -42,11 +46,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Job reference - description: Complete reference of the Discovery Job object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_list_of_discoveries_by_discovery_id, + discovery.Discovery.get_discovery_jobs_by_ip + - Paths used are get /dna/intent/api/v1/discovery/job, + get /dna/intent/api/v1/discovery/{id}/job """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_range_delete.py b/plugins/modules/discovery_range_delete.py index 7a45a9888a..bc00564005 100644 --- a/plugins/modules/discovery_range_delete.py +++ b/plugins/modules/discovery_range_delete.py @@ -10,6 +10,7 @@ short_description: Resource module for Discovery Range Delete description: - Manage operation delete of the resource Discovery Range Delete. +- Stops discovery for the given range and removes them. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Range Delete reference - description: Complete reference of the Discovery Range Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.delete_discovery_by_specified_range + - Paths used are delete /dna/intent/api/v1/discovery/{startIndex}/{recordsToDelete} """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_range_info.py b/plugins/modules/discovery_range_info.py index 7a5d97fe33..a9f15315cd 100644 --- a/plugins/modules/discovery_range_info.py +++ b/plugins/modules/discovery_range_info.py @@ -10,6 +10,7 @@ short_description: Information module for Discovery Range description: - Get all Discovery Range. +- Returns the discovery by specified range. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Range reference - description: Complete reference of the Discovery Range object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_discoveries_by_range + - Paths used are get /dna/intent/api/v1/discovery/{startIndex}/{recordsToReturn} """ EXAMPLES = r""" diff --git a/plugins/modules/discovery_summary_info.py b/plugins/modules/discovery_summary_info.py index ff49b8672d..12c0809a7d 100644 --- a/plugins/modules/discovery_summary_info.py +++ b/plugins/modules/discovery_summary_info.py @@ -10,6 +10,7 @@ short_description: Information module for Discovery Summary description: - Get all Discovery Summary. +- Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the "Get Discoveries by range" API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -61,11 +62,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Discovery Summary reference - description: Complete reference of the Discovery Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_network_devices_from_discovery + - Paths used are get /dna/intent/api/v1/discovery/{id}/summary """ EXAMPLES = r""" diff --git a/plugins/modules/dna_command_runner_keywords_info.py b/plugins/modules/dna_command_runner_keywords_info.py index 0bed46c2fe..7760802bb8 100644 --- a/plugins/modules/dna_command_runner_keywords_info.py +++ b/plugins/modules/dna_command_runner_keywords_info.py @@ -10,6 +10,7 @@ short_description: Information module for Dna Command Runner Keywords description: - Get all Dna Command Runner Keywords. +- Get valid keywords. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Dna Command Runner Keywords reference - description: Complete reference of the Dna Command Runner Keywords object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + command_runner.CommandRunner.get_all_keywords_of_clis_accepted + - Paths used are get /dna/intent/api/v1/network-device-poller/cli/legit-reads """ EXAMPLES = r""" diff --git a/plugins/modules/dnacaap_management_execution_status_info.py b/plugins/modules/dnacaap_management_execution_status_info.py index 4feb6c0159..7fcabdbe75 100644 --- a/plugins/modules/dnacaap_management_execution_status_info.py +++ b/plugins/modules/dnacaap_management_execution_status_info.py @@ -10,6 +10,7 @@ short_description: Information module for Dnacaap Management Execution Status description: - Get Dnacaap Management Execution Status by id. +- Retrieves the execution details of a Business API. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Dnacaap Management Execution Status reference - description: Complete reference of the Dnacaap Management Execution Status object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + task.Task.get_business_api_execution_details + - Paths used are get /dna/intent/api/v1/dnacaap/management/execution-status/{executionId} """ EXAMPLES = r""" diff --git a/plugins/modules/endpoint_analytics_profiling_rules.py b/plugins/modules/endpoint_analytics_profiling_rules.py index d9e36c8b60..cfdbb28190 100644 --- a/plugins/modules/endpoint_analytics_profiling_rules.py +++ b/plugins/modules/endpoint_analytics_profiling_rules.py @@ -10,6 +10,8 @@ short_description: Resource module for Endpoint Analytics Profiling Rules description: - Manage operations create, update and delete of the resource Endpoint Analytics Profiling Rules. +- Creates profiling rule from the request body. +- Deletes the profiling rule for the given 'ruleId'. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -114,11 +116,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Endpoint Analytics Profiling Rules reference - description: Complete reference of the Endpoint Analytics Profiling Rules object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + policy.Policy.update_an_existing_profiling_rule, + policy.Policy.create_a_profiling_rule, + policy.Policy.delete_an_existing_profiling_rule + - Paths used are post /dna/intent/api/v1/endpoint-analytics/profiling-rules, + delete /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId} """ EXAMPLES = r""" diff --git a/plugins/modules/endpoint_analytics_profiling_rules_info.py b/plugins/modules/endpoint_analytics_profiling_rules_info.py index 2299d5daab..106129e9fe 100644 --- a/plugins/modules/endpoint_analytics_profiling_rules_info.py +++ b/plugins/modules/endpoint_analytics_profiling_rules_info.py @@ -10,7 +10,14 @@ short_description: Information module for Endpoint Analytics Profiling Rules description: - Get all Endpoint Analytics Profiling Rules. -- Get Endpoint Analytics Profiling Rules by id. +- This API fetches the list of profiling rules. It can be used to show profiling rules in client applications, or export those from an environment. + 'POST /profiling-rules/bulk' API can be used to import such exported rules into another environment. + If this API is used to export rules to be imported into another Cisco DNA Center system, then ensure that 'includeDeleted' parameter is 'true', + so that deleted rules get synchronized correctly. + Use query parameters to filter the data, as required. If no filter is provided, then it will include only rules of type 'Custom Rule' in the response. + By default, the response is limited to 500 records. Use 'limit' parameter to fetch higher number of records, if required. + 'GET /profiling-rules/count' API can be used to find out the total number of rules in the system. +- Fetches details of the profiling rule for the given 'ruleId'. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -54,11 +61,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Endpoint Analytics Profiling Rules reference - description: Complete reference of the Endpoint Analytics Profiling Rules object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + policy.Policy.get_list_of_profiling_rules, + policy.Policy.get_details_of_a_single_profiling_rule + - Paths used are get /dna/intent/api/v1/endpoint-analytics/profiling-rules, + get /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId} """ EXAMPLES = r""" diff --git a/plugins/modules/event_api_status_info.py b/plugins/modules/event_api_status_info.py index 1cf165060e..3eb9000b22 100644 --- a/plugins/modules/event_api_status_info.py +++ b/plugins/modules/event_api_status_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Api Status description: - Get Event Api Status by id. +- Get the Status of events API calls with provided executionId as mandatory path parameter. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Api Status reference - description: Complete reference of the Event Api Status object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_status_api_for_events + - Paths used are get /dna/intent/api/v1/event/api-status/{executionId} """ EXAMPLES = r""" diff --git a/plugins/modules/event_artifact_count_info.py b/plugins/modules/event_artifact_count_info.py index 0d776049c2..5a596cb697 100644 --- a/plugins/modules/event_artifact_count_info.py +++ b/plugins/modules/event_artifact_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Artifact Count description: - Get all Event Artifact Count. +- Get the count of registered event artifacts with provided eventIds or tags as mandatory. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Artifact Count reference - description: Complete reference of the Event Artifact Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.eventartifact_count + - Paths used are get /dna/system/api/v1/event/artifact/count """ EXAMPLES = r""" diff --git a/plugins/modules/event_artifact_info.py b/plugins/modules/event_artifact_info.py index 71d5c80a8b..1b8d945ddb 100644 --- a/plugins/modules/event_artifact_info.py +++ b/plugins/modules/event_artifact_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Artifact description: - Get all Event Artifact. +- Gets the list of artifacts based on provided offset and limit. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -49,11 +50,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Artifact reference - description: Complete reference of the Event Artifact object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_eventartifacts + - Paths used are get /dna/system/api/v1/event/artifact """ EXAMPLES = r""" diff --git a/plugins/modules/event_count_info.py b/plugins/modules/event_count_info.py index a6042aefda..fcde2b58c4 100644 --- a/plugins/modules/event_count_info.py +++ b/plugins/modules/event_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Count description: - Get all Event Count. +- Get the count of registered events with provided eventIds or tags as mandatory. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Count reference - description: Complete reference of the Event Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.count_of_events + - Paths used are get /dna/intent/api/v1/events/count """ EXAMPLES = r""" diff --git a/plugins/modules/event_info.py b/plugins/modules/event_info.py index a66b1aeae8..786f66035e 100644 --- a/plugins/modules/event_info.py +++ b/plugins/modules/event_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event description: - Get all Event. +- Gets the list of registered Events with provided eventIds or tags as mandatory. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -45,11 +46,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event reference - description: Complete reference of the Event object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_events + - Paths used are get /dna/intent/api/v1/events """ EXAMPLES = r""" diff --git a/plugins/modules/event_series_audit_logs_info.py b/plugins/modules/event_series_audit_logs_info.py index ce26904df6..23dbf7c57a 100644 --- a/plugins/modules/event_series_audit_logs_info.py +++ b/plugins/modules/event_series_audit_logs_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Series Audit Logs description: - Get all Event Series Audit Logs. +- Get Audit Log Event instances from the Event-Hub. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -123,11 +124,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Series Audit Logs reference - description: Complete reference of the Event Series Audit Logs object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_auditlog_records + - Paths used are get /dna/data/api/v1/event/event-series/audit-logs """ EXAMPLES = r""" diff --git a/plugins/modules/event_series_audit_logs_parent_records_info.py b/plugins/modules/event_series_audit_logs_parent_records_info.py index 8095424e59..20b78012cf 100644 --- a/plugins/modules/event_series_audit_logs_parent_records_info.py +++ b/plugins/modules/event_series_audit_logs_parent_records_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Series Audit Logs Parent Records description: - Get all Event Series Audit Logs Parent Records. +- Get Parent Audit Log Event instances from the Event-Hub. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -119,11 +120,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Series Audit Logs Parent Records reference - description: Complete reference of the Event Series Audit Logs Parent Records object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_auditlog_parent_records + - Paths used are get /dna/data/api/v1/event/event-series/audit-log/parent-records """ EXAMPLES = r""" diff --git a/plugins/modules/event_series_audit_logs_summary_info.py b/plugins/modules/event_series_audit_logs_summary_info.py index ff14032041..a139fe2078 100644 --- a/plugins/modules/event_series_audit_logs_summary_info.py +++ b/plugins/modules/event_series_audit_logs_summary_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Series Audit Logs Summary description: - Get all Event Series Audit Logs Summary. +- Get Audit Log Summary from the Event-Hub. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -107,11 +108,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Series Audit Logs Summary reference - description: Complete reference of the Event Series Audit Logs Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_auditlog_summary + - Paths used are get /dna/data/api/v1/event/event-series/audit-log/summary """ EXAMPLES = r""" diff --git a/plugins/modules/event_series_count_info.py b/plugins/modules/event_series_count_info.py index 7d0f5882b5..9bc8271de3 100644 --- a/plugins/modules/event_series_count_info.py +++ b/plugins/modules/event_series_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Series Count description: - Get all Event Series Count. +- Get the Count of Published Notifications. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -57,11 +58,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Series Count reference - description: Complete reference of the Event Series Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.count_of_notifications + - Paths used are get /dna/intent/api/v1/event/event-series/count """ EXAMPLES = r""" diff --git a/plugins/modules/event_series_info.py b/plugins/modules/event_series_info.py index f8678a7ed6..eeb44a0cd5 100644 --- a/plugins/modules/event_series_info.py +++ b/plugins/modules/event_series_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Series description: - Get all Event Series. +- Get the list of Published Notifications. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -73,11 +74,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Series reference - description: Complete reference of the Event Series object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_notifications + - Paths used are get /dna/intent/api/v1/event/event-series """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription.py b/plugins/modules/event_subscription.py index b766643f71..e8b0b0d25e 100644 --- a/plugins/modules/event_subscription.py +++ b/plugins/modules/event_subscription.py @@ -10,6 +10,9 @@ short_description: Resource module for Event Subscription description: - Manage operations create, update and delete of the resource Event Subscription. +- Delete EventSubscriptions. +- Update SubscriptionEndpoint to list of registered events. +- Subscribe SubscriptionEndpoint to list of registered events. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -68,11 +71,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription reference - description: Complete reference of the Event Subscription object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.update_event_subscriptions, + event_management.EventManagement.create_event_subscriptions + - Paths used are delete /dna/intent/api/v1/event/subscription, + put /dna/intent/api/v1/event/subscription, + post /dna/intent/api/v1/event/subscription """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_count_info.py b/plugins/modules/event_subscription_count_info.py index 0782a6d495..8d59544f9e 100644 --- a/plugins/modules/event_subscription_count_info.py +++ b/plugins/modules/event_subscription_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription Count description: - Get all Event Subscription Count. +- Returns the Count of EventSubscriptions. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Count reference - description: Complete reference of the Event Subscription Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.count_of_event_subscriptions + - Paths used are get /dna/intent/api/v1/event/subscription/count """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_details_email_info.py b/plugins/modules/event_subscription_details_email_info.py index 6119ab8093..731c1e2032 100644 --- a/plugins/modules/event_subscription_details_email_info.py +++ b/plugins/modules/event_subscription_details_email_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription Details Email description: - Get all Event Subscription Details Email. +- Gets the list of subscription details for specified connectorType. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Details Email reference - description: Complete reference of the Event Subscription Details Email object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_email_subscription_details + - Paths used are get /dna/intent/api/v1/event/subscription-details/email """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_details_rest_info.py b/plugins/modules/event_subscription_details_rest_info.py index e925afe144..79ebc8b6eb 100644 --- a/plugins/modules/event_subscription_details_rest_info.py +++ b/plugins/modules/event_subscription_details_rest_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription Details Rest description: - Get all Event Subscription Details Rest. +- Gets the list of subscription details for specified connectorType. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Details Rest reference - description: Complete reference of the Event Subscription Details Rest object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_rest_webhook_subscription_details + - Paths used are get /dna/intent/api/v1/event/subscription-details/rest """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_details_syslog_info.py b/plugins/modules/event_subscription_details_syslog_info.py index d994c33425..5f61b595dd 100644 --- a/plugins/modules/event_subscription_details_syslog_info.py +++ b/plugins/modules/event_subscription_details_syslog_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription Details Syslog description: - Get all Event Subscription Details Syslog. +- Gets the list of subscription details for specified connectorType. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Details Syslog reference - description: Complete reference of the Event Subscription Details Syslog object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_syslog_subscription_details + - Paths used are get /dna/intent/api/v1/event/subscription-details/syslog """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_email.py b/plugins/modules/event_subscription_email.py index 1b99dd1f61..8f2abaf26b 100644 --- a/plugins/modules/event_subscription_email.py +++ b/plugins/modules/event_subscription_email.py @@ -10,6 +10,8 @@ short_description: Resource module for Event Subscription Email description: - Manage operations create and update of the resource Event Subscription Email. +- Create Email Subscription Endpoint for list of registered events. +- Update Email Subscription Endpoint for list of registered events. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -66,11 +68,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Email reference - description: Complete reference of the Event Subscription Email object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.create_email_event_subscription, + event_management.EventManagement.update_email_event_subscription + - Paths used are post /dna/intent/api/v1/event/subscription/email, + put /dna/intent/api/v1/event/subscription/email """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_email_info.py b/plugins/modules/event_subscription_email_info.py index 38f81a793e..49f3323b6b 100644 --- a/plugins/modules/event_subscription_email_info.py +++ b/plugins/modules/event_subscription_email_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription Email description: - Get all Event Subscription Email. +- Gets the list of email Subscriptions's based on provided offset and limit. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -43,11 +44,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Email reference - description: Complete reference of the Event Subscription Email object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_email_event_subscriptions + - Paths used are get /dna/intent/api/v1/event/subscription/email """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_info.py b/plugins/modules/event_subscription_info.py index eeb63f4e6a..c9482a42c8 100644 --- a/plugins/modules/event_subscription_info.py +++ b/plugins/modules/event_subscription_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription description: - Get all Event Subscription. +- Gets the list of Subscriptions's based on provided offset and limit. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription reference - description: Complete reference of the Event Subscription object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_event_subscriptions + - Paths used are get /dna/intent/api/v1/event/subscription """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_rest.py b/plugins/modules/event_subscription_rest.py index cfe2c4db94..582979546e 100644 --- a/plugins/modules/event_subscription_rest.py +++ b/plugins/modules/event_subscription_rest.py @@ -10,6 +10,8 @@ short_description: Resource module for Event Subscription Rest description: - Manage operations create and update of the resource Event Subscription Rest. +- Create Rest/Webhook Subscription Endpoint for list of registered events. +- Update Rest/Webhook Subscription Endpoint for list of registered events. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -56,11 +58,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Rest reference - description: Complete reference of the Event Subscription Rest object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.create_rest_webhook_event_subscription, + event_management.EventManagement.update_rest_webhook_event_subscription + - Paths used are post /dna/intent/api/v1/event/subscription/rest, + put /dna/intent/api/v1/event/subscription/rest """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_rest_info.py b/plugins/modules/event_subscription_rest_info.py index dcdec229cb..4f7ba36dfc 100644 --- a/plugins/modules/event_subscription_rest_info.py +++ b/plugins/modules/event_subscription_rest_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription Rest description: - Get all Event Subscription Rest. +- Gets the list of Rest/Webhook Subscriptions's based on provided offset and limit. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Rest reference - description: Complete reference of the Event Subscription Rest object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_rest_webhook_event_subscriptions + - Paths used are get /dna/intent/api/v1/event/subscription/rest """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_syslog.py b/plugins/modules/event_subscription_syslog.py index 1776157da1..3e52430278 100644 --- a/plugins/modules/event_subscription_syslog.py +++ b/plugins/modules/event_subscription_syslog.py @@ -10,6 +10,8 @@ short_description: Resource module for Event Subscription Syslog description: - Manage operations create and update of the resource Event Subscription Syslog. +- Update Syslog Subscription Endpoint for list of registered events. +- Create Syslog Subscription Endpoint for list of registered events. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -56,11 +58,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Syslog reference - description: Complete reference of the Event Subscription Syslog object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.update_syslog_event_subscription, + event_management.EventManagement.create_syslog_event_subscription + - Paths used are put /dna/intent/api/v1/event/subscription/syslog, + post /dna/intent/api/v1/event/subscription/syslog """ EXAMPLES = r""" diff --git a/plugins/modules/event_subscription_syslog_info.py b/plugins/modules/event_subscription_syslog_info.py index 7fad7f519c..7244d105bc 100644 --- a/plugins/modules/event_subscription_syslog_info.py +++ b/plugins/modules/event_subscription_syslog_info.py @@ -10,6 +10,7 @@ short_description: Information module for Event Subscription Syslog description: - Get all Event Subscription Syslog. +- Gets the list of Syslog Subscriptions's based on provided offset and limit. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Event Subscription Syslog reference - description: Complete reference of the Event Subscription Syslog object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + event_management.EventManagement.get_syslog_event_subscriptions + - Paths used are get /dna/intent/api/v1/event/subscription/syslog """ EXAMPLES = r""" diff --git a/plugins/modules/file_info.py b/plugins/modules/file_info.py index ccd95944b2..99aeeb9b71 100644 --- a/plugins/modules/file_info.py +++ b/plugins/modules/file_info.py @@ -10,6 +10,7 @@ short_description: Information module for File description: - Get File by id. +- Downloads a file specified by fileId. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: File reference - description: Complete reference of the File object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + file.File.download_a_file_by_fileid + - Paths used are get /dna/intent/api/v1/file/{fileId} """ EXAMPLES = r""" diff --git a/plugins/modules/file_namespace_files_info.py b/plugins/modules/file_namespace_files_info.py index 2feff2532b..ec81278708 100644 --- a/plugins/modules/file_namespace_files_info.py +++ b/plugins/modules/file_namespace_files_info.py @@ -10,6 +10,7 @@ short_description: Information module for File Namespace Files description: - Get File Namespace Files by name. +- Returns list of files under a specific namespace. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: File Namespace Files reference - description: Complete reference of the File Namespace Files object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + file.File.get_list_of_files + - Paths used are get /dna/intent/api/v1/file/namespace/{nameSpace} """ EXAMPLES = r""" diff --git a/plugins/modules/file_namespaces_info.py b/plugins/modules/file_namespaces_info.py index 4c1c2ebc7a..9257fedce9 100644 --- a/plugins/modules/file_namespaces_info.py +++ b/plugins/modules/file_namespaces_info.py @@ -10,6 +10,7 @@ short_description: Information module for File Namespaces description: - Get all File Namespaces. +- Returns list of available namespaces. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: File Namespaces reference - description: Complete reference of the File Namespaces object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + file.File.get_list_of_available_namespaces + - Paths used are get /dna/intent/api/v1/file/namespace """ EXAMPLES = r""" diff --git a/plugins/modules/global_credential_delete.py b/plugins/modules/global_credential_delete.py index 4c3fde57d9..19c241837f 100644 --- a/plugins/modules/global_credential_delete.py +++ b/plugins/modules/global_credential_delete.py @@ -10,6 +10,7 @@ short_description: Resource module for Global Credential Delete description: - Manage operation delete of the resource Global Credential Delete. +- Deletes global credential for the given ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Global Credential Delete reference - description: Complete reference of the Global Credential Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.delete_global_credentials_by_id + - Paths used are delete /dna/intent/api/v1/global-credential/{globalCredentialId} """ EXAMPLES = r""" diff --git a/plugins/modules/global_credential_info.py b/plugins/modules/global_credential_info.py index 93616b89ea..a412867d7d 100644 --- a/plugins/modules/global_credential_info.py +++ b/plugins/modules/global_credential_info.py @@ -11,6 +11,8 @@ description: - Get all Global Credential. - Get Global Credential by id. +- Returns global credential for the given credential sub type. +- Returns the credential sub type for the given Id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -40,11 +42,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Global Credential reference - description: Complete reference of the Global Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_credential_sub_type_by_credential_id, + discovery.Discovery.get_global_credentials + - Paths used are get /dna/intent/api/v1/global-credential, + get /dna/intent/api/v1/global-credential/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/global_credential_update.py b/plugins/modules/global_credential_update.py index d46f6891fe..fa1acca238 100644 --- a/plugins/modules/global_credential_update.py +++ b/plugins/modules/global_credential_update.py @@ -10,6 +10,7 @@ short_description: Resource module for Global Credential Update description: - Manage operation update of the resource Global Credential Update. +- Update global credential for network devices in site(s). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -25,11 +26,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Global Credential Update reference - description: Complete reference of the Global Credential Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.delete_global_credentials_by_id, + discovery.Discovery.update_global_credentials + - Paths used are put /dna/intent/api/v1/global-credential/{globalCredentialId} """ EXAMPLES = r""" diff --git a/plugins/modules/global_pool.py b/plugins/modules/global_pool.py index 21274604c5..9abbd0b9e1 100644 --- a/plugins/modules/global_pool.py +++ b/plugins/modules/global_pool.py @@ -10,6 +10,9 @@ short_description: Resource module for Global Pool description: - Manage operations create, update and delete of the resource Global Pool. +- API to update global pool. +- API to create global pool. +- API to delete global IP pool. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -46,11 +49,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Global Pool reference - description: Complete reference of the Global Pool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.delete_global_ip_pool, + network_settings.NetworkSettings.create_global_pool, + network_settings.NetworkSettings.update_global_pool + - Paths used are put /dna/intent/api/v1/global-pool, + post /dna/intent/api/v1/global-pool, + delete /dna/intent/api/v1/global-pool/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/global_pool_info.py b/plugins/modules/global_pool_info.py index 91e6fe0c61..8b52027927 100644 --- a/plugins/modules/global_pool_info.py +++ b/plugins/modules/global_pool_info.py @@ -10,6 +10,7 @@ short_description: Information module for Global Pool description: - Get all Global Pool. +- API to get global pool. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Global Pool reference - description: Complete reference of the Global Pool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.get_global_pool + - Paths used are get /dna/intent/api/v1/global-pool """ EXAMPLES = r""" diff --git a/plugins/modules/golden_image_create.py b/plugins/modules/golden_image_create.py index d3af28f8c1..6523c7dae5 100644 --- a/plugins/modules/golden_image_create.py +++ b/plugins/modules/golden_image_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Golden Image Create description: - Manage operation create of the resource Golden Image Create. +- Golden Tag image. Set siteId as -1 for Global site. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -31,11 +32,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Golden Image Create reference - description: Complete reference of the Golden Image Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.tag_as_golden_image + - Paths used are post /dna/intent/api/v1/image/importation/golden """ EXAMPLES = r""" diff --git a/plugins/modules/golden_tag_image_delete.py b/plugins/modules/golden_tag_image_delete.py index 6da4c58781..178fc7a43f 100644 --- a/plugins/modules/golden_tag_image_delete.py +++ b/plugins/modules/golden_tag_image_delete.py @@ -10,6 +10,7 @@ short_description: Resource module for Golden Tag Image Delete description: - Manage operation delete of the resource Golden Tag Image Delete. +- Remove golden tag. Set siteId as -1 for Global site. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Golden Tag Image Delete reference - description: Complete reference of the Golden Tag Image Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.remove_golden_tag_for_image + - Paths used are delete /dna/intent/api/v1/image/importation/golden/site/{siteId}/family/{deviceFamilyIdentifier}/role/{deviceRole}/image/{imageId} """ EXAMPLES = r""" diff --git a/plugins/modules/golden_tag_image_details_info.py b/plugins/modules/golden_tag_image_details_info.py index 2eda9ead13..6e88a86fe8 100644 --- a/plugins/modules/golden_tag_image_details_info.py +++ b/plugins/modules/golden_tag_image_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Golden Tag Image Details description: - Get Golden Tag Image Details by id. +- Get golden tag status of an image. Set siteId as -1 for Global site. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -39,11 +40,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Golden Tag Image Details reference - description: Complete reference of the Golden Tag Image Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.get_golden_tag_status_of_an_image + - Paths used are get /dna/intent/api/v1/image/importation/golden/site/{siteId}/family/{deviceFamilyIdentifier}/role/{deviceRole}/image/{imageId} """ EXAMPLES = r""" diff --git a/plugins/modules/http_read_credential.py b/plugins/modules/http_read_credential.py index ec91ce1ae0..c59d34dbc7 100644 --- a/plugins/modules/http_read_credential.py +++ b/plugins/modules/http_read_credential.py @@ -10,6 +10,8 @@ short_description: Resource module for Http Read Credential description: - Manage operations create and update of the resource Http Read Credential. +- Adds HTTP read credentials. +- Updates global HTTP Read credential. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -48,11 +50,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Http Read Credential reference - description: Complete reference of the Http Read Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.create_http_read_credentials, + discovery.Discovery.update_http_read_credential + - Paths used are post /dna/intent/api/v1/global-credential/http-read, + put /dna/intent/api/v1/global-credential/http-read """ EXAMPLES = r""" diff --git a/plugins/modules/http_write_credential.py b/plugins/modules/http_write_credential.py index d8303f6237..b8942c22fc 100644 --- a/plugins/modules/http_write_credential.py +++ b/plugins/modules/http_write_credential.py @@ -10,6 +10,8 @@ short_description: Resource module for Http Write Credential description: - Manage operations create and update of the resource Http Write Credential. +- Updates global HTTP write credentials. +- Adds global HTTP write credentials. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -48,11 +50,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Http Write Credential reference - description: Complete reference of the Http Write Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.create_http_write_credentials, + discovery.Discovery.update_http_write_credentials + - Paths used are put /dna/intent/api/v1/global-credential/http-write, + post /dna/intent/api/v1/global-credential/http-write """ EXAMPLES = r""" diff --git a/plugins/modules/interface_network_device_detail_info.py b/plugins/modules/interface_network_device_detail_info.py index 2e1a755eb0..e075bd29e1 100644 --- a/plugins/modules/interface_network_device_detail_info.py +++ b/plugins/modules/interface_network_device_detail_info.py @@ -10,6 +10,7 @@ short_description: Information module for Interface Network Device Detail description: - Get all Interface Network Device Detail. +- Returns interface by specified device Id and interface name. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Interface Network Device Detail reference - description: Complete reference of the Interface Network Device Detail object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_interface_details + - Paths used are get /dna/intent/api/v1/interface/network-device/{deviceId}/interface-name """ EXAMPLES = r""" diff --git a/plugins/modules/interface_network_device_info.py b/plugins/modules/interface_network_device_info.py index d4fe36278e..2e096e7d55 100644 --- a/plugins/modules/interface_network_device_info.py +++ b/plugins/modules/interface_network_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Interface Network Device description: - Get Interface Network Device by id. +- Returns list of interfaces by specified device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Interface Network Device reference - description: Complete reference of the Interface Network Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_interface_info_by_id + - Paths used are get /dna/intent/api/v1/interface/network-device/{deviceId} """ EXAMPLES = r""" diff --git a/plugins/modules/interface_network_device_range_info.py b/plugins/modules/interface_network_device_range_info.py index c2f94c0cfd..7dd3a3be24 100644 --- a/plugins/modules/interface_network_device_range_info.py +++ b/plugins/modules/interface_network_device_range_info.py @@ -10,6 +10,7 @@ short_description: Information module for Interface Network Device Range description: - Get all Interface Network Device Range. +- Returns the list of interfaces for the device for the specified range. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Interface Network Device Range reference - description: Complete reference of the Interface Network Device Range object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_interfaces_by_specified_range + - Paths used are get /dna/intent/api/v1/interface/network-device/{deviceId}/{startIndex}/{recordsToReturn} """ EXAMPLES = r""" diff --git a/plugins/modules/issues_enrichment_details_info.py b/plugins/modules/issues_enrichment_details_info.py index 534967115d..f5ed2e8867 100644 --- a/plugins/modules/issues_enrichment_details_info.py +++ b/plugins/modules/issues_enrichment_details_info.py @@ -10,6 +10,8 @@ short_description: Information module for Issues Enrichment Details description: - Get all Issues Enrichment Details. +- Enriches a given network issue context an issue id or end user's Mac Address + with details about the issue(s), impacted hosts and suggested actions for remediation. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Issues Enrichment Details reference - description: Complete reference of the Issues Enrichment Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + issues.Issues.get_issue_enrichment_details + - Paths used are get /dna/intent/api/v1/issue-enrichment-details """ EXAMPLES = r""" diff --git a/plugins/modules/issues_info.py b/plugins/modules/issues_info.py index 934897904d..a998099f67 100644 --- a/plugins/modules/issues_info.py +++ b/plugins/modules/issues_info.py @@ -10,6 +10,7 @@ short_description: Information module for Issues description: - Get all Issues. +- Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device's MAC address. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -57,11 +58,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Issues reference - description: Complete reference of the Issues object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + issues.Issues.issues + - Paths used are get /dna/intent/api/v1/issues """ EXAMPLES = r""" diff --git a/plugins/modules/itsm_cmdb_sync_status_info.py b/plugins/modules/itsm_cmdb_sync_status_info.py index c36ab85a71..6c00d4bb4a 100644 --- a/plugins/modules/itsm_cmdb_sync_status_info.py +++ b/plugins/modules/itsm_cmdb_sync_status_info.py @@ -10,6 +10,9 @@ short_description: Information module for Itsm Cmdb Sync Status description: - Get all Itsm Cmdb Sync Status. +- This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter "status","date". + The supported values for status field are "Success","Failed","Unknown" and date field should be in "YYYY-MM-DD" format. + By default all the cmdb sync status will be send as response and based on the query parameter filtered detail will be send as response. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -31,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Itsm Cmdb Sync Status reference - description: Complete reference of the Itsm Cmdb Sync Status object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + itsm.Itsm.get_cmdb_sync_status + - Paths used are get /dna/intent/api/v1/cmdb-sync/detail """ EXAMPLES = r""" diff --git a/plugins/modules/itsm_integration_events_failed_info.py b/plugins/modules/itsm_integration_events_failed_info.py index 2bf06dabc6..6a9ffe3136 100644 --- a/plugins/modules/itsm_integration_events_failed_info.py +++ b/plugins/modules/itsm_integration_events_failed_info.py @@ -10,6 +10,7 @@ short_description: Information module for Itsm Integration Events Failed description: - Get all Itsm Integration Events Failed. +- Used to retrieve the list of integration events that failed to create tickets in ITSM. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Itsm Integration Events Failed reference - description: Complete reference of the Itsm Integration Events Failed object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + itsm.Itsm.get_failed_itsm_events + - Paths used are get /dna/intent/api/v1/integration/events """ EXAMPLES = r""" diff --git a/plugins/modules/itsm_integration_events_retry.py b/plugins/modules/itsm_integration_events_retry.py index 1e62d0d9cd..627db9c48e 100644 --- a/plugins/modules/itsm_integration_events_retry.py +++ b/plugins/modules/itsm_integration_events_retry.py @@ -10,6 +10,10 @@ short_description: Resource module for Itsm Integration Events Retry description: - Manage operation create of the resource Itsm Integration Events Retry. +- Allows retry of multiple failed ITSM event instances. + The retry request payload can be given as a list of strings. + A minimum of one instance Id is mandatory. + The list of failed event instance Ids can be retrieved using the Get Failed ITSM Events API in the instanceId attribute. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -22,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Itsm Integration Events Retry reference - description: Complete reference of the Itsm Integration Events Retry object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + itsm.Itsm.retry_integration_events + - Paths used are post /dna/intent/api/v1/integration/events """ EXAMPLES = r""" diff --git a/plugins/modules/license_device_count_info.py b/plugins/modules/license_device_count_info.py index 9bcde028e7..1cc3f97a81 100644 --- a/plugins/modules/license_device_count_info.py +++ b/plugins/modules/license_device_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for License Device Count description: - Get all License Device Count. +- Get total number of managed device(s). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Device Count reference - description: Complete reference of the License Device Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.device_count_details + - Paths used are get /dna/intent/api/v1/licenses/device/count """ EXAMPLES = r""" diff --git a/plugins/modules/license_device_deregistration.py b/plugins/modules/license_device_deregistration.py index b39ddde780..71d939ba03 100644 --- a/plugins/modules/license_device_deregistration.py +++ b/plugins/modules/license_device_deregistration.py @@ -10,6 +10,7 @@ short_description: Resource module for License Device Deregistration description: - Manage operation update of the resource License Device Deregistration. +- Deregister device(s) from CSSM(Cisco Smart Software Manager). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -22,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Device Deregistration reference - description: Complete reference of the License Device Deregistration object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.device_deregistration + - Paths used are put /dna/intent/api/v1/licenses/smartAccount/virtualAccount/deregister """ EXAMPLES = r""" diff --git a/plugins/modules/license_device_license_details_info.py b/plugins/modules/license_device_license_details_info.py index e0ef06fc50..d887f221a9 100644 --- a/plugins/modules/license_device_license_details_info.py +++ b/plugins/modules/license_device_license_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for License Device License Details description: - Get all License Device License Details. +- Get detailed license information of a device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Device License Details reference - description: Complete reference of the License Device License Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.device_license_details + - Paths used are get /dna/intent/api/v1/licenses/device/{device_uuid}/details """ EXAMPLES = r""" diff --git a/plugins/modules/license_device_license_summary_info.py b/plugins/modules/license_device_license_summary_info.py index 65e7d44ba0..a05a7f76ae 100644 --- a/plugins/modules/license_device_license_summary_info.py +++ b/plugins/modules/license_device_license_summary_info.py @@ -10,6 +10,7 @@ short_description: Information module for License Device License Summary description: - Get all License Device License Summary. +- Show license summary of device(s). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -61,11 +62,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Device License Summary reference - description: Complete reference of the License Device License Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.device_license_summary + - Paths used are get /dna/intent/api/v1/licenses/device/summary """ EXAMPLES = r""" diff --git a/plugins/modules/license_device_registration.py b/plugins/modules/license_device_registration.py index 622d7a2a98..5a3995eb0f 100644 --- a/plugins/modules/license_device_registration.py +++ b/plugins/modules/license_device_registration.py @@ -10,6 +10,7 @@ short_description: Resource module for License Device Registration description: - Manage operation update of the resource License Device Registration. +- Register device(s) in CSSM(Cisco Smart Software Manager). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Device Registration reference - description: Complete reference of the License Device Registration object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.device_registration + - Paths used are put /dna/intent/api/v1/licenses/smartAccount/virtualAccount/{virtual_account_name}/register """ EXAMPLES = r""" diff --git a/plugins/modules/license_smart_account_details_info.py b/plugins/modules/license_smart_account_details_info.py index c146cebcaa..620454137d 100644 --- a/plugins/modules/license_smart_account_details_info.py +++ b/plugins/modules/license_smart_account_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for License Smart Account Details description: - Get all License Smart Account Details. +- Get detail of all smart accounts. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Smart Account Details reference - description: Complete reference of the License Smart Account Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.smart_account_details + - Paths used are get /dna/intent/api/v1/licenses/smartAccounts """ EXAMPLES = r""" diff --git a/plugins/modules/license_term_details_info.py b/plugins/modules/license_term_details_info.py index 18d3a30c80..9c66fb5936 100644 --- a/plugins/modules/license_term_details_info.py +++ b/plugins/modules/license_term_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for License Term Details description: - Get License Term Details by name. +- Get license term details. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -35,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Term Details reference - description: Complete reference of the License Term Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.license_term_details + - Paths used are get /dna/intent/api/v1/licenses/term/smartAccount/{smart_account_id}/virtualAccount/{virtual_account_name} """ EXAMPLES = r""" diff --git a/plugins/modules/license_usage_details_info.py b/plugins/modules/license_usage_details_info.py index 35bcabd235..118e56e82c 100644 --- a/plugins/modules/license_usage_details_info.py +++ b/plugins/modules/license_usage_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for License Usage Details description: - Get License Usage Details by name. +- Get count of purchased and in use Cisco DNA and Network licenses. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -35,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Usage Details reference - description: Complete reference of the License Usage Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.license_usage_details + - Paths used are get /dna/intent/api/v1/licenses/usage/smartAccount/{smart_account_id}/virtualAccount/{virtual_account_name} """ EXAMPLES = r""" diff --git a/plugins/modules/license_virtual_account_change.py b/plugins/modules/license_virtual_account_change.py index f2a2cf140b..7a750e2357 100644 --- a/plugins/modules/license_virtual_account_change.py +++ b/plugins/modules/license_virtual_account_change.py @@ -10,6 +10,7 @@ short_description: Resource module for License Virtual Account Change description: - Manage operation create of the resource License Virtual Account Change. +- Transfer device(s) from one virtual account to another within same smart account. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -28,11 +29,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Virtual Account Change reference - description: Complete reference of the License Virtual Account Change object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.change_virtual_account + - Paths used are post /dna/intent/api/v1/licenses/smartAccount/{smart_account_id}/virtualAccount/{virtual_account_name}/device/transfer """ EXAMPLES = r""" diff --git a/plugins/modules/license_virtual_account_details_info.py b/plugins/modules/license_virtual_account_details_info.py index 488e717d87..94516bf58d 100644 --- a/plugins/modules/license_virtual_account_details_info.py +++ b/plugins/modules/license_virtual_account_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for License Virtual Account Details description: - Get all License Virtual Account Details. +- Get virtual account details of a smart account. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: License Virtual Account Details reference - description: Complete reference of the License Virtual Account Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + licenses.Licenses.virtual_account_details + - Paths used are get /dna/intent/api/v1/licenses/smartAccount/{smart_account_id}/virtualAccounts """ EXAMPLES = r""" diff --git a/plugins/modules/netconf_credential.py b/plugins/modules/netconf_credential.py index d4d5540cbe..72afab43a6 100644 --- a/plugins/modules/netconf_credential.py +++ b/plugins/modules/netconf_credential.py @@ -10,6 +10,8 @@ short_description: Resource module for Netconf Credential description: - Manage operations create and update of the resource Netconf Credential. +- Updates global netconf credentials. +- Adds global netconf credentials. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -39,11 +41,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Netconf Credential reference - description: Complete reference of the Netconf Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.update_netconf_credentials, + discovery.Discovery.create_netconf_credentials + - Paths used are put /dna/intent/api/v1/global-credential/netconf, + post /dna/intent/api/v1/global-credential/netconf """ EXAMPLES = r""" diff --git a/plugins/modules/network_create.py b/plugins/modules/network_create.py index df4ce81391..d76aefb76e 100644 --- a/plugins/modules/network_create.py +++ b/plugins/modules/network_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Network Create description: - Manage operation create of the resource Network Create. +- API to create a network for DHCP and DNS center server settings. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -135,11 +136,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Create reference - description: Complete reference of the Network Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.create_network + - Paths used are post /dna/intent/api/v1/network/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device.py b/plugins/modules/network_device.py index 54d4a99ee5..27e5a59175 100644 --- a/plugins/modules/network_device.py +++ b/plugins/modules/network_device.py @@ -10,6 +10,9 @@ short_description: Resource module for Network Device description: - Manage operations create, update and delete of the resource Network Device. +- Adds the device with given credential. +- Sync the devices provided as input. +- Deletes the network device for the given Id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -115,11 +118,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device reference - description: Complete reference of the Network Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.delete_device_by_id, + devices.Devices.add_device, + devices.Devices.sync_devices + - Paths used are post /dna/intent/api/v1/network-device, + put /dna/intent/api/v1/network-device, + delete /dna/intent/api/v1/network-device/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_by_ip_info.py b/plugins/modules/network_device_by_ip_info.py index 1ea2123cb1..ad7b7ce0e9 100644 --- a/plugins/modules/network_device_by_ip_info.py +++ b/plugins/modules/network_device_by_ip_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device By Ip description: - Get Network Device By Ip by id. +- Returns the network device by specified IP address. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device By Ip reference - description: Complete reference of the Network Device By Ip object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_network_device_by_ip + - Paths used are get /dna/intent/api/v1/network-device/ip-address/{ipAddress} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_by_serial_number_info.py b/plugins/modules/network_device_by_serial_number_info.py index 173da31574..be26d2dada 100644 --- a/plugins/modules/network_device_by_serial_number_info.py +++ b/plugins/modules/network_device_by_serial_number_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device By Serial Number description: - Get Network Device By Serial Number by id. +- Returns the network device with given serial number. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device By Serial Number reference - description: Complete reference of the Network Device By Serial Number object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_by_serial_number + - Paths used are get /dna/intent/api/v1/network-device/serial-number/{serialNumber} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_chassis_details_info.py b/plugins/modules/network_device_chassis_details_info.py index 397394297d..2a39bb6cd9 100644 --- a/plugins/modules/network_device_chassis_details_info.py +++ b/plugins/modules/network_device_chassis_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Chassis Details description: - Get all Network Device Chassis Details. +- Returns chassis details for given device ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Chassis Details reference - description: Complete reference of the Network Device Chassis Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_chassis_details_for_device + - Paths used are get /dna/intent/api/v1/network-device/{deviceId}/chassis """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_config_count_info.py b/plugins/modules/network_device_config_count_info.py index 5abb31a3c5..2fb0dd6f6e 100644 --- a/plugins/modules/network_device_config_count_info.py +++ b/plugins/modules/network_device_config_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Config Count description: - Get all Network Device Config Count. +- Returns the count of device configs. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Config Count reference - description: Complete reference of the Network Device Config Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_config_count + - Paths used are get /dna/intent/api/v1/network-device/config/count """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_config_info.py b/plugins/modules/network_device_config_info.py index fa97384a8a..30fda716b7 100644 --- a/plugins/modules/network_device_config_info.py +++ b/plugins/modules/network_device_config_info.py @@ -10,7 +10,8 @@ short_description: Information module for Network Device Config description: - Get all Network Device Config. -- Get Network Device Config by id. +- Returns the config for all devices. +- Returns the device config by specified device ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -26,11 +27,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Config reference - description: Complete reference of the Network Device Config object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_config_by_id + - Paths used are get /dna/intent/api/v1/network-device/config, + get /dna/intent/api/v1/network-device/{networkDeviceId}/config """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_count_info.py b/plugins/modules/network_device_count_info.py index d3ac69b4f3..e9f7192485 100644 --- a/plugins/modules/network_device_count_info.py +++ b/plugins/modules/network_device_count_info.py @@ -11,6 +11,8 @@ description: - Get all Network Device Count. - Get Network Device Count by id. +- Returns the interface count for the given device. +- Returns the count of network devices based on the filter criteria by management IP address, mac address, hostname and location name. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -26,11 +28,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Count reference - description: Complete reference of the Network Device Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_count, + devices.Devices.get_device_interface_count_by_id + - Paths used are get /dna/intent/api/v1/interface/network-device/{deviceId}/count, + get /dna/intent/api/v1/network-device/count """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_equipment_info.py b/plugins/modules/network_device_equipment_info.py index 684053ba8a..1bb618f32c 100644 --- a/plugins/modules/network_device_equipment_info.py +++ b/plugins/modules/network_device_equipment_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Equipment description: - Get all Network Device Equipment. +- Return PowerSupply/ Fan details for the Given device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Equipment reference - description: Complete reference of the Network Device Equipment object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.return_power_supply_fan_details_for_the_given_device + - Paths used are get /dna/intent/api/v1/network-device/{deviceUuid}/equipment """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_export.py b/plugins/modules/network_device_export.py index 38f20d6c26..5ed3ca92b9 100644 --- a/plugins/modules/network_device_export.py +++ b/plugins/modules/network_device_export.py @@ -10,6 +10,7 @@ short_description: Resource module for Network Device Export description: - Manage operation create of the resource Network Device Export. +- Exports the selected network device to a file. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -35,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Export reference - description: Complete reference of the Network Device Export object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.export_device_list + - Paths used are post /dna/intent/api/v1/network-device/file """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_functional_capability_info.py b/plugins/modules/network_device_functional_capability_info.py index 12a38885ea..abc2b56b84 100644 --- a/plugins/modules/network_device_functional_capability_info.py +++ b/plugins/modules/network_device_functional_capability_info.py @@ -11,6 +11,8 @@ description: - Get all Network Device Functional Capability. - Get Network Device Functional Capability by id. +- Returns the functional-capability for given devices. +- Returns functional capability with given Id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -36,11 +38,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Functional Capability reference - description: Complete reference of the Network Device Functional Capability object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_functional_capability_by_id, + devices.Devices.get_functional_capability_for_devices + - Paths used are get /dna/intent/api/v1/network-device/functional-capability, + get /dna/intent/api/v1/network-device/functional-capability/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_global_polling_interval_info.py b/plugins/modules/network_device_global_polling_interval_info.py index 435fa87223..605554f18b 100644 --- a/plugins/modules/network_device_global_polling_interval_info.py +++ b/plugins/modules/network_device_global_polling_interval_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Global Polling Interval description: - Get all Network Device Global Polling Interval. +- Returns polling interval of all devices. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Global Polling Interval reference - description: Complete reference of the Network Device Global Polling Interval object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_polling_interval_for_all_devices + - Paths used are get /dna/intent/api/v1/network-device/collection-schedule/global """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_info.py b/plugins/modules/network_device_info.py index c8d0c05f4a..65831d9630 100644 --- a/plugins/modules/network_device_info.py +++ b/plugins/modules/network_device_info.py @@ -11,6 +11,9 @@ description: - Get all Network Device. - Get Network Device by id. +- Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. + If id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. +- Returns the network device details for the given device ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -152,11 +155,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device reference - description: Complete reference of the Network Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_by_id, + devices.Devices.get_device_list + - Paths used are get /dna/intent/api/v1/network-device, + get /dna/intent/api/v1/network-device/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_interface_poe_info.py b/plugins/modules/network_device_interface_poe_info.py index 462ebe40d8..82ccc6fec9 100644 --- a/plugins/modules/network_device_interface_poe_info.py +++ b/plugins/modules/network_device_interface_poe_info.py @@ -10,6 +10,8 @@ short_description: Information module for Network Device Interface Poe description: - Get all Network Device Interface Poe. +- Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names + which is optional and returns information for that particular interfaces where(operStatus = operationalStatus). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +31,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Interface Poe reference - description: Complete reference of the Network Device Interface Poe object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.poe_interface_details + - Paths used are get /dna/intent/api/v1/network-device/{deviceUuid}/interface/poe-detail """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_inventory_insight_link_mismatch_info.py b/plugins/modules/network_device_inventory_insight_link_mismatch_info.py index 014534f347..a4daec2171 100644 --- a/plugins/modules/network_device_inventory_insight_link_mismatch_info.py +++ b/plugins/modules/network_device_inventory_insight_link_mismatch_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Inventory Insight Link Mismatch description: - Get all Network Device Inventory Insight Link Mismatch. +- Find all devices with link mismatch (speed / vlan). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -45,11 +46,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Inventory Insight Link Mismatch reference - description: Complete reference of the Network Device Inventory Insight Link Mismatch object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.inventory_insight_device_link_mismatch + - Paths used are get /dna/intent/api/v1/network-device/insight/{siteId}/device-link """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_lexicographically_sorted_info.py b/plugins/modules/network_device_lexicographically_sorted_info.py index 967cc75a56..747e781179 100644 --- a/plugins/modules/network_device_lexicographically_sorted_info.py +++ b/plugins/modules/network_device_lexicographically_sorted_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Lexicographically Sorted description: - Get all Network Device Lexicographically Sorted. +- Returns the list of values of the first given required parameter. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -109,11 +110,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Lexicographically Sorted reference - description: Complete reference of the Network Device Lexicographically Sorted object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_values_that_match_fully_or_partially_an_attribute + - Paths used are get /dna/intent/api/v1/network-device/autocomplete """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_linecard_details_info.py b/plugins/modules/network_device_linecard_details_info.py index 274b52932a..d138723e97 100644 --- a/plugins/modules/network_device_linecard_details_info.py +++ b/plugins/modules/network_device_linecard_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Linecard Details description: - Get all Network Device Linecard Details. +- Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Linecard Details reference - description: Complete reference of the Network Device Linecard Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_linecard_details + - Paths used are get /dna/intent/api/v1/network-device/{deviceUuid}/line-card """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_meraki_organization_info.py b/plugins/modules/network_device_meraki_organization_info.py index a5d9f0cb50..01998c14ff 100644 --- a/plugins/modules/network_device_meraki_organization_info.py +++ b/plugins/modules/network_device_meraki_organization_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Meraki Organization description: - Get all Network Device Meraki Organization. +- Returns list of organizations for meraki dashboard. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Meraki Organization reference - description: Complete reference of the Network Device Meraki Organization object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_organization_list_for_meraki + - Paths used are get /dna/intent/api/v1/network-device/{id}/meraki-organization """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_module_count_info.py b/plugins/modules/network_device_module_count_info.py index 505f842877..a131c50b77 100644 --- a/plugins/modules/network_device_module_count_info.py +++ b/plugins/modules/network_device_module_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Module Count description: - Get all Network Device Module Count. +- Returns Module Count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Module Count reference - description: Complete reference of the Network Device Module Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_module_count + - Paths used are get /dna/intent/api/v1/network-device/module/count """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_module_info.py b/plugins/modules/network_device_module_info.py index 796307ee5b..d9e7192532 100644 --- a/plugins/modules/network_device_module_info.py +++ b/plugins/modules/network_device_module_info.py @@ -11,6 +11,8 @@ description: - Get all Network Device Module. - Get Network Device Module by id. +- Returns modules by specified device id. +- Returns Module info by id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -54,11 +56,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Module reference - description: Complete reference of the Network Device Module object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_module_info_by_id, + devices.Devices.get_modules + - Paths used are get /dna/intent/api/v1/network-device/module, + get /dna/intent/api/v1/network-device/module/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_poe_info.py b/plugins/modules/network_device_poe_info.py index fad9ba491c..de8f98bca1 100644 --- a/plugins/modules/network_device_poe_info.py +++ b/plugins/modules/network_device_poe_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Poe description: - Get all Network Device Poe. +- Returns POE details for device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Poe reference - description: Complete reference of the Network Device Poe object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.poe_details + - Paths used are get /dna/intent/api/v1/network-device/{deviceUuid}/poe """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_polling_interval_info.py b/plugins/modules/network_device_polling_interval_info.py index 19937df3aa..e2d7765570 100644 --- a/plugins/modules/network_device_polling_interval_info.py +++ b/plugins/modules/network_device_polling_interval_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Polling Interval description: - Get all Network Device Polling Interval. +- Returns polling interval by device id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Polling Interval reference - description: Complete reference of the Network Device Polling Interval object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_polling_interval_by_id + - Paths used are get /dna/intent/api/v1/network-device/{id}/collection-schedule """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_range_info.py b/plugins/modules/network_device_range_info.py index b6d001381e..c3044a245f 100644 --- a/plugins/modules/network_device_range_info.py +++ b/plugins/modules/network_device_range_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Range description: - Get all Network Device Range. +- Returns the list of network devices for the given pagination range. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Range reference - description: Complete reference of the Network Device Range object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_network_device_by_pagination_range + - Paths used are get /dna/intent/api/v1/network-device/{startIndex}/{recordsToReturn} """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_register_for_wsa_info.py b/plugins/modules/network_device_register_for_wsa_info.py index ff774383f6..43ed76f7c1 100644 --- a/plugins/modules/network_device_register_for_wsa_info.py +++ b/plugins/modules/network_device_register_for_wsa_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Register For Wsa description: - Get all Network Device Register For Wsa. +- Registers a device for WSA notification. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Register For Wsa reference - description: Complete reference of the Network Device Register For Wsa object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.register_device_for_wsa + - Paths used are get /dna/intent/api/v1/network-device/tenantinfo/macaddress """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_stack_details_info.py b/plugins/modules/network_device_stack_details_info.py index 95b0695743..8e0990d648 100644 --- a/plugins/modules/network_device_stack_details_info.py +++ b/plugins/modules/network_device_stack_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Stack Details description: - Get all Network Device Stack Details. +- Retrieves complete stack details for given device ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Stack Details reference - description: Complete reference of the Network Device Stack Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_stack_details_for_device + - Paths used are get /dna/intent/api/v1/network-device/{deviceId}/stack """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_summary_info.py b/plugins/modules/network_device_summary_info.py index 8500c5a928..bb65e8fd05 100644 --- a/plugins/modules/network_device_summary_info.py +++ b/plugins/modules/network_device_summary_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Summary description: - Get all Network Device Summary. +- Returns brief summary of device info such as hostname, management IP address for the given device Id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Summary reference - description: Complete reference of the Network Device Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_summary + - Paths used are get /dna/intent/api/v1/network-device/{id}/brief """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_supervisor_card_details_info.py b/plugins/modules/network_device_supervisor_card_details_info.py index eb0ec319f8..4843069336 100644 --- a/plugins/modules/network_device_supervisor_card_details_info.py +++ b/plugins/modules/network_device_supervisor_card_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Supervisor Card Details description: - Get all Network Device Supervisor Card Details. +- Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Supervisor Card Details reference - description: Complete reference of the Network Device Supervisor Card Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_supervisor_card_detail + - Paths used are get /dna/intent/api/v1/network-device/{deviceUuid}/supervisor-card """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_sync.py b/plugins/modules/network_device_sync.py index 01e535f2c1..779844051a 100644 --- a/plugins/modules/network_device_sync.py +++ b/plugins/modules/network_device_sync.py @@ -10,6 +10,9 @@ short_description: Resource module for Network Device Sync description: - Manage operation update of the resource Network Device Sync. +- Synchronizes the devices. If forceSync param is false (default) then the sync would run in normal priority thread. + If forceSync param is true then the sync would run in high priority thread if available, else the sync will fail. + Result can be seen in the child task of each device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -25,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Sync reference - description: Complete reference of the Network Device Sync object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.sync_devices_using_forcesync + - Paths used are put /dna/intent/api/v1/network-device/sync """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_update_role.py b/plugins/modules/network_device_update_role.py index 0530b24261..00f0b6d67b 100644 --- a/plugins/modules/network_device_update_role.py +++ b/plugins/modules/network_device_update_role.py @@ -10,6 +10,7 @@ short_description: Resource module for Network Device Update Role description: - Manage operation update of the resource Network Device Update Role. +- Updates the role of the device as access, core, distribution, border router. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Update Role reference - description: Complete reference of the Network Device Update Role object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.update_device_role + - Paths used are put /dna/intent/api/v1/network-device/brief """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_vlan_info.py b/plugins/modules/network_device_vlan_info.py index 2b423645ae..0987b610a1 100644 --- a/plugins/modules/network_device_vlan_info.py +++ b/plugins/modules/network_device_vlan_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Vlan description: - Get all Network Device Vlan. +- Returns Device Interface VLANs. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Vlan reference - description: Complete reference of the Network Device Vlan object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_device_interface_vlans + - Paths used are get /dna/intent/api/v1/network-device/{id}/vlan """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_wireless_lan_info.py b/plugins/modules/network_device_wireless_lan_info.py index 65e7aee1d3..f5689bba94 100644 --- a/plugins/modules/network_device_wireless_lan_info.py +++ b/plugins/modules/network_device_wireless_lan_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device Wireless Lan description: - Get all Network Device Wireless Lan. +- Returns the wireless lan controller info with given device ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device Wireless Lan reference - description: Complete reference of the Network Device Wireless Lan object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_wireless_lan_controller_details_by_id + - Paths used are get /dna/intent/api/v1/network-device/{id}/wireless-info """ EXAMPLES = r""" diff --git a/plugins/modules/network_device_with_snmp_v3_des_info.py b/plugins/modules/network_device_with_snmp_v3_des_info.py index 771938a7dd..6c674e2600 100644 --- a/plugins/modules/network_device_with_snmp_v3_des_info.py +++ b/plugins/modules/network_device_with_snmp_v3_des_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network Device With Snmp V3 Des description: - Get all Network Device With Snmp V3 Des. +- Returns devices added to DNAC with snmp v3 DES, where siteId is mandatory & accepts offset, limit, sortby, order which are optional. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Device With Snmp V3 Des reference - description: Complete reference of the Network Device With Snmp V3 Des object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.get_devices_with_snmpv3_des + - Paths used are get /dna/intent/api/v1/network-device/insight/{siteId}/insecure-connection """ EXAMPLES = r""" diff --git a/plugins/modules/network_info.py b/plugins/modules/network_info.py index 732207efed..5916aa12cc 100644 --- a/plugins/modules/network_info.py +++ b/plugins/modules/network_info.py @@ -10,6 +10,7 @@ short_description: Information module for Network description: - Get all Network. +- API to get DHCP and DNS center server details. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network reference - description: Complete reference of the Network object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.get_network + - Paths used are get /dna/intent/api/v1/network """ EXAMPLES = r""" diff --git a/plugins/modules/network_update.py b/plugins/modules/network_update.py index 67af1f25a5..50da568095 100644 --- a/plugins/modules/network_update.py +++ b/plugins/modules/network_update.py @@ -10,6 +10,7 @@ short_description: Resource module for Network Update description: - Manage operation update of the resource Network Update. +- API to update network for DHCP and DNS center server settings. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -135,11 +136,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Network Update reference - description: Complete reference of the Network Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.update_network, + network_settings.NetworkSettings.create_network + - Paths used are put /dna/intent/api/v1/network/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/nfv_profile.py b/plugins/modules/nfv_profile.py index 92187e846d..d87f109385 100644 --- a/plugins/modules/nfv_profile.py +++ b/plugins/modules/nfv_profile.py @@ -10,6 +10,8 @@ short_description: Resource module for Nfv Profile description: - Manage operations create, update and delete of the resource Nfv Profile. +- API to create network profile for different NFV topologies. +- API to delete nfv network profile. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -142,11 +144,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Nfv Profile reference - description: Complete reference of the Nfv Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.delete_nfv_profile, + site_design.SiteDesign.create_nfv_profile, + site_design.SiteDesign.update_nfv_profile + - Paths used are post /dna/intent/api/v1/nfv/network-profile, + delete /dna/intent/api/v1/nfv/network-profile/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/nfv_profile_info.py b/plugins/modules/nfv_profile_info.py index ae809b5a0e..a9fa158aac 100644 --- a/plugins/modules/nfv_profile_info.py +++ b/plugins/modules/nfv_profile_info.py @@ -10,6 +10,7 @@ short_description: Information module for Nfv Profile description: - Get Nfv Profile by id. +- API to get NFV network profile. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -37,11 +38,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Nfv Profile reference - description: Complete reference of the Nfv Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.get_nfv_profile + - Paths used are get /dna/intent/api/v1/nfv/network-profile/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/nfv_provision.py b/plugins/modules/nfv_provision.py index 6f0b9ae83e..60cd667d47 100644 --- a/plugins/modules/nfv_provision.py +++ b/plugins/modules/nfv_provision.py @@ -10,6 +10,7 @@ short_description: Resource module for Nfv Provision description: - Manage operation create of the resource Nfv Provision. +- Design and Provision single/multi NFV device with given site/area/building/floor . version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -357,11 +358,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Nfv Provision reference - description: Complete reference of the Nfv Provision object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.provision_nfv + - Paths used are post /dna/intent/api/v1/business/nfv """ EXAMPLES = r""" diff --git a/plugins/modules/nfv_provision_detail_info.py b/plugins/modules/nfv_provision_detail_info.py index b8c68662a3..23e874422d 100644 --- a/plugins/modules/nfv_provision_detail_info.py +++ b/plugins/modules/nfv_provision_detail_info.py @@ -10,6 +10,7 @@ short_description: Information module for Nfv Provision Detail description: - Get all Nfv Provision Detail. +- Returns provisioning device information for the specified IP address. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Nfv Provision Detail reference - description: Complete reference of the Nfv Provision Detail object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.get_device_details_by_ip + - Paths used are get /dna/intent/api/v1/business/nfv/provisioningDetail """ EXAMPLES = r""" diff --git a/plugins/modules/nfv_provision_details.py b/plugins/modules/nfv_provision_details.py index eab093bd76..85f362311b 100644 --- a/plugins/modules/nfv_provision_details.py +++ b/plugins/modules/nfv_provision_details.py @@ -10,6 +10,7 @@ short_description: Resource module for Nfv Provision Details description: - Manage operation create of the resource Nfv Provision Details. +- Checks the provisioning detail of an ENCS device including log information. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Nfv Provision Details reference - description: Complete reference of the Nfv Provision Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.nfv_provisioning_detail + - Paths used are post /dna/intent/api/v1/nfv-provision-detail """ EXAMPLES = r""" diff --git a/plugins/modules/path_trace.py b/plugins/modules/path_trace.py index 7eb9c98a1e..f108a9d494 100644 --- a/plugins/modules/path_trace.py +++ b/plugins/modules/path_trace.py @@ -10,6 +10,8 @@ short_description: Resource module for Path Trace description: - Manage operations create and delete of the resource Path Trace. +- Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress. +- Deletes a flow analysis request by its id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -46,11 +48,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Path Trace reference - description: Complete reference of the Path Trace object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + path_trace.PathTrace.initiate_a_new_pathtrace, + path_trace.PathTrace.deletes_pathtrace_by_id + - Paths used are post /dna/intent/api/v1/flow-analysis, + delete /dna/intent/api/v1/flow-analysis/{flowAnalysisId} """ EXAMPLES = r""" diff --git a/plugins/modules/path_trace_info.py b/plugins/modules/path_trace_info.py index 0033ef4044..cdf97dbe8b 100644 --- a/plugins/modules/path_trace_info.py +++ b/plugins/modules/path_trace_info.py @@ -11,6 +11,8 @@ description: - Get all Path Trace. - Get Path Trace by id. +- Returns a summary of all flow analyses stored. Results can be filtered by specified parameters. +- Returns result of a previously requested flow analysis by its Flow Analysis id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -86,11 +88,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Path Trace reference - description: Complete reference of the Path Trace object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + path_trace.PathTrace.retrives_all_previous_pathtraces_summary, + path_trace.PathTrace.retrieves_previous_pathtrace + - Paths used are get /dna/intent/api/v1/flow-analysis, + get /dna/intent/api/v1/flow-analysis/{flowAnalysisId} """ EXAMPLES = r""" diff --git a/plugins/modules/platform_nodes_configuration_summary_info.py b/plugins/modules/platform_nodes_configuration_summary_info.py index af49b3430c..8754114910 100644 --- a/plugins/modules/platform_nodes_configuration_summary_info.py +++ b/plugins/modules/platform_nodes_configuration_summary_info.py @@ -10,6 +10,8 @@ short_description: Information module for Platform Nodes Configuration Summary description: - Get all Platform Nodes Configuration Summary. +- Provides details about the current Cisco DNA Center node configuration, such as API version, node name, NTP server, + intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default gateway, and interface information. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Platform Nodes Configuration Summary reference - description: Complete reference of the Platform Nodes Configuration Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + platform_configuration.PlatformConfiguration.nodes_configuration_summary + - Paths used are get /dna/intent/api/v1/nodes-config """ EXAMPLES = r""" diff --git a/plugins/modules/platform_release_summary_info.py b/plugins/modules/platform_release_summary_info.py index 249a52d4b5..acc0e2e1eb 100644 --- a/plugins/modules/platform_release_summary_info.py +++ b/plugins/modules/platform_release_summary_info.py @@ -10,6 +10,8 @@ short_description: Information module for Platform Release Summary description: - Get all Platform Release Summary. +- Provides information such as API version, mandatory core packages for installation or upgrade, optional packages, + Cisco DNA Center name and version, supported direct updates, and tenant ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Platform Release Summary reference - description: Complete reference of the Platform Release Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + platform_configuration.PlatformConfiguration.release_summary + - Paths used are get /dna/intent/api/v1/dnac-release """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device.py b/plugins/modules/pnp_device.py index 0866673c8b..5f9c46bd2b 100644 --- a/plugins/modules/pnp_device.py +++ b/plugins/modules/pnp_device.py @@ -10,6 +10,8 @@ short_description: Resource module for Pnp Device description: - Manage operations create, update and delete of the resource Pnp Device. +- Adds a device to the PnP database. +- Deletes specified device from PnP database. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -804,11 +806,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device reference - description: Complete reference of the Pnp Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.update_device, + device_onboarding_pnp.DeviceOnboardingPnp.add_device, + device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device, + delete /dna/intent/api/v1/onboarding/pnp-device/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_claim.py b/plugins/modules/pnp_device_claim.py index 50242e1321..ff4500fac4 100644 --- a/plugins/modules/pnp_device_claim.py +++ b/plugins/modules/pnp_device_claim.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Device Claim description: - Manage operation create of the resource Pnp Device Claim. +- Claims one of more devices with specified workflow. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -75,11 +76,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device Claim reference - description: Complete reference of the Pnp Device Claim object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.claim_device + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device/claim """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_claim_to_site.py b/plugins/modules/pnp_device_claim_to_site.py index 25ee4b0347..24ff6e8c07 100644 --- a/plugins/modules/pnp_device_claim_to_site.py +++ b/plugins/modules/pnp_device_claim_to_site.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Device Claim To Site description: - Manage operation create of the resource Pnp Device Claim To Site. +- Claim a device based on DNA-C Site based design process. Different parameters are required for different device platforms. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device Claim To Site reference - description: Complete reference of the Pnp Device Claim To Site object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.claim_a_device_to_a_site + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device/site-claim """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_config_preview.py b/plugins/modules/pnp_device_config_preview.py index 4f38b80351..c6dcc1b606 100644 --- a/plugins/modules/pnp_device_config_preview.py +++ b/plugins/modules/pnp_device_config_preview.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Device Config Preview description: - Manage operation create of the resource Pnp Device Config Preview. +- Triggers a preview for site-based Day 0 Configuration. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device Config Preview reference - description: Complete reference of the Pnp Device Config Preview object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.preview_config + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device/site-config-preview """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_count_info.py b/plugins/modules/pnp_device_count_info.py index 93149fab8d..b2e2e7a018 100644 --- a/plugins/modules/pnp_device_count_info.py +++ b/plugins/modules/pnp_device_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Pnp Device Count description: - Get all Pnp Device Count. +- Returns the device count based on filter criteria. This is useful for pagination. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -77,11 +78,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device Count reference - description: Complete reference of the Pnp Device Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_device_count + - Paths used are get /dna/intent/api/v1/onboarding/pnp-device/count """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_history_info.py b/plugins/modules/pnp_device_history_info.py index be60f35553..6b23a811b2 100644 --- a/plugins/modules/pnp_device_history_info.py +++ b/plugins/modules/pnp_device_history_info.py @@ -10,6 +10,7 @@ short_description: Information module for Pnp Device History description: - Get all Pnp Device History. +- Returns history for a specific device. Serial number is a required parameter. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device History reference - description: Complete reference of the Pnp Device History object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_device_history + - Paths used are get /dna/intent/api/v1/onboarding/pnp-device/history """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_import.py b/plugins/modules/pnp_device_import.py index 4b4062fb28..0030e0e014 100644 --- a/plugins/modules/pnp_device_import.py +++ b/plugins/modules/pnp_device_import.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Device Import description: - Manage operation create of the resource Pnp Device Import. +- Add devices to PnP in bulk. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -805,11 +806,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device Import reference - description: Complete reference of the Pnp Device Import object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.import_devices_in_bulk + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device/import """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_info.py b/plugins/modules/pnp_device_info.py index c96780c638..2e471a906c 100644 --- a/plugins/modules/pnp_device_info.py +++ b/plugins/modules/pnp_device_info.py @@ -11,6 +11,9 @@ description: - Get all Pnp Device. - Get Pnp Device by id. +- Returns list of devices based on filter crieteria. If a limit is not specified, it will default to return 50 devices. + Pagination and sorting are also supported by this endpoint. +- Returns device details specified by device id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -110,11 +113,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device reference - description: Complete reference of the Pnp Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id, + device_onboarding_pnp.DeviceOnboardingPnp.get_device_list + - Paths used are get /dna/intent/api/v1/onboarding/pnp-device, + get /dna/intent/api/v1/onboarding/pnp-device/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_reset.py b/plugins/modules/pnp_device_reset.py index 2b53f04d15..f37582f712 100644 --- a/plugins/modules/pnp_device_reset.py +++ b/plugins/modules/pnp_device_reset.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Device Reset description: - Manage operation create of the resource Pnp Device Reset. +- Recovers a device from a Workflow Execution Error state. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -57,11 +58,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device Reset reference - description: Complete reference of the Pnp Device Reset object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.reset_device + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device/reset """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_device_unclaim.py b/plugins/modules/pnp_device_unclaim.py index 936149ee14..f6c1d98869 100644 --- a/plugins/modules/pnp_device_unclaim.py +++ b/plugins/modules/pnp_device_unclaim.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Device Unclaim description: - Manage operation create of the resource Pnp Device Unclaim. +- Un-Claims one of more devices with specified workflow. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -22,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Device Unclaim reference - description: Complete reference of the Pnp Device Unclaim object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.un_claim_device + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device/unclaim """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_global_settings.py b/plugins/modules/pnp_global_settings.py index 189032176b..592eec8706 100644 --- a/plugins/modules/pnp_global_settings.py +++ b/plugins/modules/pnp_global_settings.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Global Settings description: - Manage operation update of the resource Pnp Global Settings. +- Updates the user's list of global PnP settings. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -157,11 +158,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Global Settings reference - description: Complete reference of the Pnp Global Settings object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.update_pnp_global_settings + - Paths used are put /dna/intent/api/v1/onboarding/pnp-settings """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_global_settings_info.py b/plugins/modules/pnp_global_settings_info.py index 12c6ca8e81..619e2262fc 100644 --- a/plugins/modules/pnp_global_settings_info.py +++ b/plugins/modules/pnp_global_settings_info.py @@ -10,6 +10,7 @@ short_description: Information module for Pnp Global Settings description: - Get all Pnp Global Settings. +- Returns global PnP settings of the user. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Global Settings reference - description: Complete reference of the Pnp Global Settings object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_pnp_global_settings + - Paths used are get /dna/intent/api/v1/onboarding/pnp-settings """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_server_profile_update.py b/plugins/modules/pnp_server_profile_update.py index d9b7999d20..3cec41b97a 100644 --- a/plugins/modules/pnp_server_profile_update.py +++ b/plugins/modules/pnp_server_profile_update.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Server Profile Update description: - Manage operation update of the resource Pnp Server Profile Update. +- Updates the PnP Server profile in a registered Virtual Account in the PnP database. The response payload returns the updated smart & virtual account info. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -97,11 +98,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Server Profile Update reference - description: Complete reference of the Pnp Server Profile Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.update_pnp_server_profile + - Paths used are put /dna/intent/api/v1/onboarding/pnp-settings/savacct """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_smart_account_domains_info.py b/plugins/modules/pnp_smart_account_domains_info.py index f8bbd5dcd7..1076a20fa6 100644 --- a/plugins/modules/pnp_smart_account_domains_info.py +++ b/plugins/modules/pnp_smart_account_domains_info.py @@ -10,6 +10,7 @@ short_description: Information module for Pnp Smart Account Domains description: - Get all Pnp Smart Account Domains. +- Returns the list of Smart Account domains. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Smart Account Domains reference - description: Complete reference of the Pnp Smart Account Domains object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_smart_account_list + - Paths used are get /dna/intent/api/v1/onboarding/pnp-settings/sacct """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_virtual_account_add.py b/plugins/modules/pnp_virtual_account_add.py index e874a4cb92..64fe6d5342 100644 --- a/plugins/modules/pnp_virtual_account_add.py +++ b/plugins/modules/pnp_virtual_account_add.py @@ -10,6 +10,9 @@ short_description: Resource module for Pnp Virtual Account Add description: - Manage operation create of the resource Pnp Virtual Account Add. +- Registers a Smart Account, Virtual Account and the relevant server profile info with the PnP System & database. + The devices present in the registered virtual account are synced with the PnP database as well. + The response payload returns the new profile. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -97,11 +100,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Virtual Account Add reference - description: Complete reference of the Pnp Virtual Account Add object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.add_virtual_account + - Paths used are post /dna/intent/api/v1/onboarding/pnp-settings/savacct """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_virtual_account_deregister.py b/plugins/modules/pnp_virtual_account_deregister.py index dc4e4806b2..e4649033a2 100644 --- a/plugins/modules/pnp_virtual_account_deregister.py +++ b/plugins/modules/pnp_virtual_account_deregister.py @@ -10,6 +10,9 @@ short_description: Resource module for Pnp Virtual Account Deregister description: - Manage operation delete of the resource Pnp Virtual Account Deregister. +- Deregisters the specified smart account & virtual account info and the associated device information from the PnP System & database. + The devices associated with the deregistered virtual account are removed from the PnP database as well. + The response payload contains the deregistered smart & virtual account information. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +27,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Virtual Account Deregister reference - description: Complete reference of the Pnp Virtual Account Deregister object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.deregister_virtual_account + - Paths used are delete /dna/intent/api/v1/onboarding/pnp-settings/vacct """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_virtual_account_devices_sync.py b/plugins/modules/pnp_virtual_account_devices_sync.py index 945c8ee7ff..fe0007e7e2 100644 --- a/plugins/modules/pnp_virtual_account_devices_sync.py +++ b/plugins/modules/pnp_virtual_account_devices_sync.py @@ -10,6 +10,7 @@ short_description: Resource module for Pnp Virtual Account Devices Sync description: - Manage operation create of the resource Pnp Virtual Account Devices Sync. +- Synchronizes the device info from the given smart account & virtual account with the PnP database. The response payload returns a list of synced devices. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -97,11 +98,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Virtual Account Devices Sync reference - description: Complete reference of the Pnp Virtual Account Devices Sync object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.sync_virtual_account_devices + - Paths used are post /dna/intent/api/v1/onboarding/pnp-device/vacct-sync """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_virtual_account_sync_result_info.py b/plugins/modules/pnp_virtual_account_sync_result_info.py index ca28a93ff4..4611a11f22 100644 --- a/plugins/modules/pnp_virtual_account_sync_result_info.py +++ b/plugins/modules/pnp_virtual_account_sync_result_info.py @@ -10,6 +10,7 @@ short_description: Information module for Pnp Virtual Account Sync Result description: - Get all Pnp Virtual Account Sync Result. +- Returns the summary of devices synced from the given smart account & virtual account with PnP. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Virtual Account Sync Result reference - description: Complete reference of the Pnp Virtual Account Sync Result object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_sync_result_for_virtual_account + - Paths used are get /dna/intent/api/v1/onboarding/pnp-device/sacct/{domain}/vacct/{name}/sync-result """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_virtual_accounts_info.py b/plugins/modules/pnp_virtual_accounts_info.py index 9625aebfb0..2f9ab9fa0c 100644 --- a/plugins/modules/pnp_virtual_accounts_info.py +++ b/plugins/modules/pnp_virtual_accounts_info.py @@ -10,6 +10,7 @@ short_description: Information module for Pnp Virtual Accounts description: - Get all Pnp Virtual Accounts. +- Returns list of virtual accounts associated with the specified smart account. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Virtual Accounts reference - description: Complete reference of the Pnp Virtual Accounts object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_virtual_account_list + - Paths used are get /dna/intent/api/v1/onboarding/pnp-settings/sacct/{domain}/vacct """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_workflow.py b/plugins/modules/pnp_workflow.py index d99f252b98..cb27e43471 100644 --- a/plugins/modules/pnp_workflow.py +++ b/plugins/modules/pnp_workflow.py @@ -10,6 +10,8 @@ short_description: Resource module for Pnp Workflow description: - Manage operations create, update and delete of the resource Pnp Workflow. +- Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database. +- Deletes a workflow specified by id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -125,11 +127,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Workflow reference - description: Complete reference of the Pnp Workflow object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.update_workflow, + device_onboarding_pnp.DeviceOnboardingPnp.add_a_workflow, + device_onboarding_pnp.DeviceOnboardingPnp.delete_workflow_by_id + - Paths used are post /dna/intent/api/v1/onboarding/pnp-workflow, + delete /dna/intent/api/v1/onboarding/pnp-workflow/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_workflow_count_info.py b/plugins/modules/pnp_workflow_count_info.py index 734ba2e454..48f79abfa3 100644 --- a/plugins/modules/pnp_workflow_count_info.py +++ b/plugins/modules/pnp_workflow_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Pnp Workflow Count description: - Get all Pnp Workflow Count. +- Returns the workflow count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Workflow Count reference - description: Complete reference of the Pnp Workflow Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_workflow_count + - Paths used are get /dna/intent/api/v1/onboarding/pnp-workflow/count """ EXAMPLES = r""" diff --git a/plugins/modules/pnp_workflow_info.py b/plugins/modules/pnp_workflow_info.py index 4e6a979917..b34b1d769d 100644 --- a/plugins/modules/pnp_workflow_info.py +++ b/plugins/modules/pnp_workflow_info.py @@ -11,6 +11,9 @@ description: - Get all Pnp Workflow. - Get Pnp Workflow by id. +- Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. + Pagination and sorting are also supported by this endpoint. +- Returns a workflow specified by id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -50,11 +53,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Pnp Workflow reference - description: Complete reference of the Pnp Workflow object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + device_onboarding_pnp.DeviceOnboardingPnp.get_workflows, + device_onboarding_pnp.DeviceOnboardingPnp.get_workflow_by_id + - Paths used are get /dna/intent/api/v1/onboarding/pnp-workflow, + get /dna/intent/api/v1/onboarding/pnp-workflow/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/profiling_rules_count_info.py b/plugins/modules/profiling_rules_count_info.py index 788d16ecf5..7605e6ea46 100644 --- a/plugins/modules/profiling_rules_count_info.py +++ b/plugins/modules/profiling_rules_count_info.py @@ -10,6 +10,8 @@ short_description: Information module for Profiling Rules Count description: - Get all Profiling Rules Count. +- This API fetches the count of profiling rules based on the filter values provided in the query parameters. + The filter parameters are same as that of 'GET /profiling-rules' API, excluding the pagination and sort parameters. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +31,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Profiling Rules Count reference - description: Complete reference of the Profiling Rules Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + policy.Policy.get_count_of_profiling_rules + - Paths used are get /dna/intent/api/v1/endpoint-analytics/profiling-rules/count """ EXAMPLES = r""" diff --git a/plugins/modules/profiling_rules_in_bulk_create.py b/plugins/modules/profiling_rules_in_bulk_create.py index 4bec58a123..6fdf3e397f 100644 --- a/plugins/modules/profiling_rules_in_bulk_create.py +++ b/plugins/modules/profiling_rules_in_bulk_create.py @@ -10,6 +10,9 @@ short_description: Resource module for Profiling Rules In Bulk Create description: - Manage operation create of the resource Profiling Rules In Bulk Create. +- This API imports the given list of profiling rules. For each record, + 1) If 'ruleType' for a record is not 'Custom Rule', then it is rejected. + 2) If 'ruleId' is provided in the input record, version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module @@ -119,11 +122,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Profiling Rules In Bulk Create reference - description: Complete reference of the Profiling Rules In Bulk Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + policy.Policy.import_profiling_rules_in_bulk + - Paths used are post /dna/intent/api/v1/endpoint-analytics/profiling-rules/bulk """ EXAMPLES = r""" diff --git a/plugins/modules/projects_details_info.py b/plugins/modules/projects_details_info.py index 7a537447a7..4551981ff8 100644 --- a/plugins/modules/projects_details_info.py +++ b/plugins/modules/projects_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Projects Details description: - Get all Projects Details. +- Get project(s) details. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Projects Details reference - description: Complete reference of the Projects Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.get_projects_details + - Paths used are get /dna/intent/api/v2/template-programmer/project """ EXAMPLES = r""" diff --git a/plugins/modules/qos_device_interface.py b/plugins/modules/qos_device_interface.py index 0ef1406cb6..fd5ebc3bae 100644 --- a/plugins/modules/qos_device_interface.py +++ b/plugins/modules/qos_device_interface.py @@ -10,7 +10,11 @@ short_description: Resource module for Qos Device Interface description: - Manage operations create, update and delete of the resource Qos Device Interface. -version_added: '3.1.0' +- Update existing qos device interface infos associate with network device id. +- Create qos device interface infos associate with network device id to allow the user to mark specific interfaces as WAN, + to associate WAN interfaces with specific SP Profile and to be able to define a shaper on WAN interfaces. +- Delete all qos device interface infos associate with network device id. +version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module author: Rafael Campos (@racampos) @@ -65,11 +69,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Qos Device Interface reference - description: Complete reference of the Qos Device Interface object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.create_qos_device_interface_info, + application_policy.ApplicationPolicy.update_qos_device_interface_info, + application_policy.ApplicationPolicy.delete_qos_device_interface_info + - Paths used are put /dna/intent/api/v1/qos-device-interface-info, + post /dna/intent/api/v1/qos-device-interface-info, + delete /dna/intent/api/v1/qos-device-interface-info/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/qos_device_interface_info.py b/plugins/modules/qos_device_interface_info.py index 8d05ffbe7c..24fb0c97bc 100644 --- a/plugins/modules/qos_device_interface_info.py +++ b/plugins/modules/qos_device_interface_info.py @@ -10,7 +10,8 @@ short_description: Information module for Qos Device Interface description: - Get all Qos Device Interface. -version_added: '3.1.0' +- Get all or by network device id, existing qos device interface infos. +version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info author: Rafael Campos (@racampos) @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Qos Device Interface reference - description: Complete reference of the Qos Device Interface object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_qos_device_interface_info + - Paths used are get /dna/intent/api/v1/qos-device-interface-info """ EXAMPLES = r""" diff --git a/plugins/modules/qos_device_interface_info_count_info.py b/plugins/modules/qos_device_interface_info_count_info.py index 6a2847e339..e73d997cf8 100644 --- a/plugins/modules/qos_device_interface_info_count_info.py +++ b/plugins/modules/qos_device_interface_info_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Qos Device Interface Info Count description: - Get all Qos Device Interface Info Count. +- Get the number of all existing qos device interface infos group by network device id. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Qos Device Interface Info Count reference - description: Complete reference of the Qos Device Interface Info Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + application_policy.ApplicationPolicy.get_qos_device_interface_info_count + - Paths used are get /dna/intent/api/v1/qos-device-interface-info-count """ EXAMPLES = r""" diff --git a/plugins/modules/reports.py b/plugins/modules/reports.py index ddcd865530..359cc6fbac 100644 --- a/plugins/modules/reports.py +++ b/plugins/modules/reports.py @@ -10,6 +10,8 @@ short_description: Resource module for Reports description: - Manage operations create and delete of the resource Reports. +- Create/Schedule a report configuration. Use "Get view details for a given view group & view" API to get the metadata required to configure a report. +- Delete a scheduled report configuration. Deletes the report executions also. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -98,11 +100,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reports reference - description: Complete reference of the Reports object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + reports.Reports.delete_a_scheduled_report, + reports.Reports.create_or_schedule_a_report + - Paths used are post /dna/intent/api/v1/data/reports, + delete /dna/intent/api/v1/data/reports/{reportId} """ EXAMPLES = r""" diff --git a/plugins/modules/reports_executions_info.py b/plugins/modules/reports_executions_info.py index e316059ae6..3dbfc0c677 100644 --- a/plugins/modules/reports_executions_info.py +++ b/plugins/modules/reports_executions_info.py @@ -11,6 +11,9 @@ description: - Get all Reports Executions. - Get Reports Executions by id. +- Get details of all executions for a given report. +- Returns report content. Save the response to a file by converting the response data as a blob + and setting the file format available from content-disposition response header. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -38,11 +41,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reports Executions reference - description: Complete reference of the Reports Executions object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + reports.Reports.get_all_execution_details_for_a_given_report, + reports.Reports.download_report_content + - Paths used are get /dna/intent/api/v1/data/reports/{reportId}/executions, + get /dna/intent/api/v1/data/reports/{reportId}/executions/{executionId} """ EXAMPLES = r""" diff --git a/plugins/modules/reports_info.py b/plugins/modules/reports_info.py index 8bab81135f..3204b351c7 100644 --- a/plugins/modules/reports_info.py +++ b/plugins/modules/reports_info.py @@ -11,6 +11,8 @@ description: - Get all Reports. - Get Reports by id. +- Get list of scheduled report configurations. +- Get scheduled report configuration by reportId. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -34,11 +36,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reports reference - description: Complete reference of the Reports object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + reports.Reports.get_list_of_scheduled_reports, + reports.Reports.get_a_scheduled_report + - Paths used are get /dna/intent/api/v1/data/reports, + get /dna/intent/api/v1/data/reports/{reportId} """ EXAMPLES = r""" diff --git a/plugins/modules/reports_view_group_info.py b/plugins/modules/reports_view_group_info.py index 4d18328bc8..c2c3e09590 100644 --- a/plugins/modules/reports_view_group_info.py +++ b/plugins/modules/reports_view_group_info.py @@ -11,6 +11,9 @@ description: - Get all Reports View Group. - Get Reports View Group by id. +- Gives a list of summary of all view groups. +- Gives a list of summary of all views in a viewgroup. + Use "Get all view groups" API to get the viewGroupIds(required as a query param for this API) for available viewgroups. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -26,11 +29,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reports View Group reference - description: Complete reference of the Reports View Group object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + reports.Reports.get_all_view_groups, + reports.Reports.get_views_for_a_given_view_group + - Paths used are get /dna/intent/api/v1/data/view-groups, + get /dna/intent/api/v1/data/view-groups/{viewGroupId} """ EXAMPLES = r""" diff --git a/plugins/modules/reports_view_group_view_info.py b/plugins/modules/reports_view_group_view_info.py index 5bc022472f..087518ccc6 100644 --- a/plugins/modules/reports_view_group_view_info.py +++ b/plugins/modules/reports_view_group_view_info.py @@ -10,6 +10,8 @@ short_description: Information module for Reports View Group View description: - Get Reports View Group View by id. +- Gives complete information of the view that is required to configure a report. + Use "Get views for a given view group" API to get the viewIds (required as a query param for this API) for available views. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +31,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reports View Group View reference - description: Complete reference of the Reports View Group View object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + reports.Reports.get_view_details_for_a_given_view_group_and_view + - Paths used are get /dna/intent/api/v1/data/view-groups/{viewGroupId}/views/{viewId} """ EXAMPLES = r""" diff --git a/plugins/modules/reserve_ip_subpool.py b/plugins/modules/reserve_ip_subpool.py index 6d169bbb5a..4fdfb24b09 100644 --- a/plugins/modules/reserve_ip_subpool.py +++ b/plugins/modules/reserve_ip_subpool.py @@ -10,6 +10,8 @@ short_description: Resource module for Reserve Ip Subpool description: - Manage operations create, update and delete of the resource Reserve Ip Subpool. +- API to delete the reserved ip subpool. +- API to reserve an ip subpool from the global pool. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -93,11 +95,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reserve Ip Subpool reference - description: Complete reference of the Reserve Ip Subpool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.release_reserve_ip_subpool, + network_settings.NetworkSettings.update_reserve_ip_subpool, + network_settings.NetworkSettings.reserve_ip_subpool + - Paths used are delete /dna/intent/api/v1/reserve-ip-subpool/{id}, + post /dna/intent/api/v1/reserve-ip-subpool/{siteId}, + put /dna/intent/api/v1/reserve-ip-subpool/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/reserve_ip_subpool_create.py b/plugins/modules/reserve_ip_subpool_create.py index cba61c74b3..1acb8d967a 100644 --- a/plugins/modules/reserve_ip_subpool_create.py +++ b/plugins/modules/reserve_ip_subpool_create.py @@ -92,11 +92,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reserve Ip Subpool Create reference - description: Complete reference of the Reserve Ip Subpool Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.reserve_ip_subpool + - Paths used are post /dna/intent/api/v1/reserve-ip-subpool/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/reserve_ip_subpool_delete.py b/plugins/modules/reserve_ip_subpool_delete.py index 4d25baba6d..35e8477d2b 100644 --- a/plugins/modules/reserve_ip_subpool_delete.py +++ b/plugins/modules/reserve_ip_subpool_delete.py @@ -21,11 +21,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reserve Ip Subpool Delete reference - description: Complete reference of the Reserve Ip Subpool Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.release_reserve_ip_subpool + - Paths used are put /dna/intent/api/v1/reserve-ip-subpool/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/reserve_ip_subpool_info.py b/plugins/modules/reserve_ip_subpool_info.py index 80375db08f..e539c06544 100644 --- a/plugins/modules/reserve_ip_subpool_info.py +++ b/plugins/modules/reserve_ip_subpool_info.py @@ -10,6 +10,7 @@ short_description: Information module for Reserve Ip Subpool description: - Get all Reserve Ip Subpool. +- API to get the ip subpool info. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reserve Ip Subpool reference - description: Complete reference of the Reserve Ip Subpool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.get_reserve_ip_subpool + - Paths used are get /dna/intent/api/v1/reserve-ip-subpool """ EXAMPLES = r""" diff --git a/plugins/modules/reserve_ip_subpool_update.py b/plugins/modules/reserve_ip_subpool_update.py index a3baa9d297..58aaa471b7 100644 --- a/plugins/modules/reserve_ip_subpool_update.py +++ b/plugins/modules/reserve_ip_subpool_update.py @@ -92,11 +92,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Reserve Ip Subpool Update reference - description: Complete reference of the Reserve Ip Subpool Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.update_reserve_ip_subpool + - Paths used are put /dna/intent/api/v1/reserve-ip-subpool/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/sda_count_info.py b/plugins/modules/sda_count_info.py index 6f7a308211..c7c6b51635 100644 --- a/plugins/modules/sda_count_info.py +++ b/plugins/modules/sda_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Count description: - Get all Sda Count. +- Get SDA Fabric Count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Count reference - description: Complete reference of the Sda Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_sda_fabric_count + - Paths used are get /dna/intent/api/v1/business/sda/fabric/count """ EXAMPLES = r""" diff --git a/plugins/modules/sda_device_info.py b/plugins/modules/sda_device_info.py index 19ffdab432..5a1bb3beda 100644 --- a/plugins/modules/sda_device_info.py +++ b/plugins/modules/sda_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Device description: - Get all Sda Device. +- Get device info from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -26,11 +27,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Device reference - description: Complete reference of the Sda Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_device_info + - Paths used are get /dna/intent/api/v1/business/sda/device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_device_role_info.py b/plugins/modules/sda_device_role_info.py index 19858cee39..5f67b14a93 100644 --- a/plugins/modules/sda_device_role_info.py +++ b/plugins/modules/sda_device_role_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Device Role description: - Get all Sda Device Role. +- Get device role in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Device Role reference - description: Complete reference of the Sda Device Role object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_device_role_in_sda_fabric + - Paths used are get /dna/intent/api/v1/business/sda/device/role """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric.py b/plugins/modules/sda_fabric.py index af77cf5200..0458bd94bd 100644 --- a/plugins/modules/sda_fabric.py +++ b/plugins/modules/sda_fabric.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Fabric description: - Manage operations create and delete of the resource Sda Fabric. +- Delete SDA Fabric. +- Add SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -21,11 +23,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric reference - description: Complete reference of the Sda Fabric object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_fabric + - Paths used are delete /dna/intent/api/v1/business/sda/fabric, + post /dna/intent/api/v1/business/sda/fabric """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_authentication_profile.py b/plugins/modules/sda_fabric_authentication_profile.py index 8af8da15d3..edeceab39a 100644 --- a/plugins/modules/sda_fabric_authentication_profile.py +++ b/plugins/modules/sda_fabric_authentication_profile.py @@ -10,6 +10,9 @@ short_description: Resource module for Sda Fabric Authentication Profile description: - Manage operations create, update and delete of the resource Sda Fabric Authentication Profile. +- Deploy authentication template in SDA Fabric. +- Update default authentication profile in SDA Fabric. +- Add default authentication profile in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -53,11 +56,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Authentication Profile reference - description: Complete reference of the Sda Fabric Authentication Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_default_authentication_profile, + sda.Sda.update_default_authentication_profile + - Paths used are post /dna/intent/api/v1/business/sda/authentication-profile, + put /dna/intent/api/v1/business/sda/authentication-profile, + delete /dna/intent/api/v1/business/sda/authentication-profile """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_authentication_profile_info.py b/plugins/modules/sda_fabric_authentication_profile_info.py index f955674444..331a4a1700 100644 --- a/plugins/modules/sda_fabric_authentication_profile_info.py +++ b/plugins/modules/sda_fabric_authentication_profile_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Fabric Authentication Profile description: - Get all Sda Fabric Authentication Profile. +- Get default authentication profile from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -30,11 +31,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Authentication Profile reference - description: Complete reference of the Sda Fabric Authentication Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_default_authentication_profile + - Paths used are get /dna/intent/api/v1/business/sda/authentication-profile """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_border_device.py b/plugins/modules/sda_fabric_border_device.py index e827e37205..7b3c985fd6 100644 --- a/plugins/modules/sda_fabric_border_device.py +++ b/plugins/modules/sda_fabric_border_device.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Fabric Border Device description: - Manage operations create and delete of the resource Sda Fabric Border Device. +- Adds border device in SDA Fabric. +- Deletes border device from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -77,11 +79,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Border Device reference - description: Complete reference of the Sda Fabric Border Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.adds_border_device + - Paths used are post /dna/intent/api/v1/business/sda/border-device, + delete /dna/intent/api/v1/business/sda/border-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_border_device_info.py b/plugins/modules/sda_fabric_border_device_info.py index e26d323739..cc7dcf210a 100644 --- a/plugins/modules/sda_fabric_border_device_info.py +++ b/plugins/modules/sda_fabric_border_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Fabric Border Device description: - Get all Sda Fabric Border Device. +- Gets border device detail from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -26,11 +27,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Border Device reference - description: Complete reference of the Sda Fabric Border Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.gets_border_device_detail + - Paths used are get /dna/intent/api/v1/business/sda/border-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_control_plane_device.py b/plugins/modules/sda_fabric_control_plane_device.py index 764e82ef08..3f235ff216 100644 --- a/plugins/modules/sda_fabric_control_plane_device.py +++ b/plugins/modules/sda_fabric_control_plane_device.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Fabric Control Plane Device description: - Manage operations create and delete of the resource Sda Fabric Control Plane Device. +- Delete control plane device in SDA Fabric. +- Add control plane device in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -26,11 +28,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Control Plane Device reference - description: Complete reference of the Sda Fabric Control Plane Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_control_plane_device + - Paths used are delete /dna/intent/api/v1/business/sda/control-plane-device, + post /dna/intent/api/v1/business/sda/control-plane-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_control_plane_device_info.py b/plugins/modules/sda_fabric_control_plane_device_info.py index 1ac7a0f77c..f9465a81b4 100644 --- a/plugins/modules/sda_fabric_control_plane_device_info.py +++ b/plugins/modules/sda_fabric_control_plane_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Fabric Control Plane Device description: - Get all Sda Fabric Control Plane Device. +- Get control plane device from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -26,11 +27,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Control Plane Device reference - description: Complete reference of the Sda Fabric Control Plane Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_control_plane_device + - Paths used are get /dna/intent/api/v1/business/sda/control-plane-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_edge_device.py b/plugins/modules/sda_fabric_edge_device.py index 122ba59815..4ac62731fb 100644 --- a/plugins/modules/sda_fabric_edge_device.py +++ b/plugins/modules/sda_fabric_edge_device.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Fabric Edge Device description: - Manage operations create and delete of the resource Sda Fabric Edge Device. +- Add edge device in SDA Fabric. +- Delete edge device from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -25,11 +27,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Edge Device reference - description: Complete reference of the Sda Fabric Edge Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_edge_device + - Paths used are post /dna/intent/api/v1/business/sda/edge-device, + delete /dna/intent/api/v1/business/sda/edge-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_edge_device_info.py b/plugins/modules/sda_fabric_edge_device_info.py index 11874d5cdd..0e63dc7df8 100644 --- a/plugins/modules/sda_fabric_edge_device_info.py +++ b/plugins/modules/sda_fabric_edge_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Fabric Edge Device description: - Get all Sda Fabric Edge Device. +- Get edge device from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Edge Device reference - description: Complete reference of the Sda Fabric Edge Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_edge_device + - Paths used are get /dna/intent/api/v1/business/sda/edge-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_info.py b/plugins/modules/sda_fabric_info.py index 9f481444e4..aa5f7aaf22 100644 --- a/plugins/modules/sda_fabric_info.py +++ b/plugins/modules/sda_fabric_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Fabric description: - Get all Sda Fabric. +- Get SDA Fabric Info. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric reference - description: Complete reference of the Sda Fabric object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_sda_fabric_info + - Paths used are get /dna/intent/api/v1/business/sda/fabric """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_site.py b/plugins/modules/sda_fabric_site.py index 003ab30848..424effe784 100644 --- a/plugins/modules/sda_fabric_site.py +++ b/plugins/modules/sda_fabric_site.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Fabric Site description: - Manage operations create and delete of the resource Sda Fabric Site. +- Delete Site from SDA Fabric. +- Add Site in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -25,11 +27,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Site reference - description: Complete reference of the Sda Fabric Site object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_site + - Paths used are delete /dna/intent/api/v1/business/sda/fabric-site, + post /dna/intent/api/v1/business/sda/fabric-site """ EXAMPLES = r""" diff --git a/plugins/modules/sda_fabric_site_info.py b/plugins/modules/sda_fabric_site_info.py index 9f5484de9a..59768fbd75 100644 --- a/plugins/modules/sda_fabric_site_info.py +++ b/plugins/modules/sda_fabric_site_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Fabric Site description: - Get all Sda Fabric Site. +- Get Site info from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Fabric Site reference - description: Complete reference of the Sda Fabric Site object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_site + - Paths used are get /dna/intent/api/v1/business/sda/fabric-site """ EXAMPLES = r""" diff --git a/plugins/modules/sda_multicast.py b/plugins/modules/sda_multicast.py index 402bb82d2e..15280476d5 100644 --- a/plugins/modules/sda_multicast.py +++ b/plugins/modules/sda_multicast.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Multicast description: - Manage operations create and delete of the resource Sda Multicast. +- Add multicast in SDA fabric. +- Delete multicast from SDA fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -49,11 +51,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Multicast reference - description: Complete reference of the Sda Multicast object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_multicast_in_sda_fabric + - Paths used are post /dna/intent/api/v1/business/sda/multicast, + delete /dna/intent/api/v1/business/sda/multicast """ EXAMPLES = r""" diff --git a/plugins/modules/sda_multicast_info.py b/plugins/modules/sda_multicast_info.py index b766f094bc..8c51f0688b 100644 --- a/plugins/modules/sda_multicast_info.py +++ b/plugins/modules/sda_multicast_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Multicast description: - Get all Sda Multicast. +- Get multicast details from SDA fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Multicast reference - description: Complete reference of the Sda Multicast object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_multicast_details_from_sda_fabric + - Paths used are get /dna/intent/api/v1/business/sda/multicast """ EXAMPLES = r""" diff --git a/plugins/modules/sda_port_assignment_for_access_point.py b/plugins/modules/sda_port_assignment_for_access_point.py index aa7e5b194d..1da56ea27d 100644 --- a/plugins/modules/sda_port_assignment_for_access_point.py +++ b/plugins/modules/sda_port_assignment_for_access_point.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Port Assignment For Access Point description: - Manage operations create and delete of the resource Sda Port Assignment For Access Point. +- Add Port assignment for access point in SDA Fabric. +- Delete Port assignment for access point in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -42,11 +44,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Port Assignment For Access Point reference - description: Complete reference of the Sda Port Assignment For Access Point object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_port_assignment_for_access_point + - Paths used are post /dna/intent/api/v1/business/sda/hostonboarding/access-point, + delete /dna/intent/api/v1/business/sda/hostonboarding/access-point """ EXAMPLES = r""" diff --git a/plugins/modules/sda_port_assignment_for_access_point_info.py b/plugins/modules/sda_port_assignment_for_access_point_info.py index 26fd370fe3..67444ded5c 100644 --- a/plugins/modules/sda_port_assignment_for_access_point_info.py +++ b/plugins/modules/sda_port_assignment_for_access_point_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Port Assignment For Access Point description: - Get all Sda Port Assignment For Access Point. +- Get Port assignment for access point in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Port Assignment For Access Point reference - description: Complete reference of the Sda Port Assignment For Access Point object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_port_assignment_for_access_point + - Paths used are get /dna/intent/api/v1/business/sda/hostonboarding/access-point """ EXAMPLES = r""" diff --git a/plugins/modules/sda_port_assignment_for_user_device.py b/plugins/modules/sda_port_assignment_for_user_device.py index 9d5aa9a342..894ae52e9e 100644 --- a/plugins/modules/sda_port_assignment_for_user_device.py +++ b/plugins/modules/sda_port_assignment_for_user_device.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Port Assignment For User Device description: - Manage operations create and delete of the resource Sda Port Assignment For User Device. +- Delete Port assignment for user device in SDA Fabric. +- Add Port assignment for user device in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -55,11 +57,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Port Assignment For User Device reference - description: Complete reference of the Sda Port Assignment For User Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_port_assignment_for_user_device + - Paths used are delete /dna/intent/api/v1/business/sda/hostonboarding/user-device, + post /dna/intent/api/v1/business/sda/hostonboarding/user-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_port_assignment_for_user_device_info.py b/plugins/modules/sda_port_assignment_for_user_device_info.py index 0031087319..8bc8cfc0fc 100644 --- a/plugins/modules/sda_port_assignment_for_user_device_info.py +++ b/plugins/modules/sda_port_assignment_for_user_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Port Assignment For User Device description: - Get all Sda Port Assignment For User Device. +- Get Port assignment for user device in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Port Assignment For User Device reference - description: Complete reference of the Sda Port Assignment For User Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_port_assignment_for_user_device + - Paths used are get /dna/intent/api/v1/business/sda/hostonboarding/user-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_provision_device.py b/plugins/modules/sda_provision_device.py index b83eb3d2d2..871f562f76 100644 --- a/plugins/modules/sda_provision_device.py +++ b/plugins/modules/sda_provision_device.py @@ -10,6 +10,9 @@ short_description: Resource module for Sda Provision Device description: - Manage operations create, update and delete of the resource Sda Provision Device. +- Delete provisioned Wired Device. +- Re-Provision Wired Device. +- Provision Wired Device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -25,11 +28,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Provision Device reference - description: Complete reference of the Sda Provision Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.re_provision_wired_device, + sda.Sda.provision_wired_device + - Paths used are delete /dna/intent/api/v1/business/sda/provision-device, + put /dna/intent/api/v1/business/sda/provision-device, + post /dna/intent/api/v1/business/sda/provision-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_provision_device_info.py b/plugins/modules/sda_provision_device_info.py index 8a4e82e089..42c016b4b8 100644 --- a/plugins/modules/sda_provision_device_info.py +++ b/plugins/modules/sda_provision_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Provision Device description: - Get all Sda Provision Device. +- Get Provisioned Wired Device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Provision Device reference - description: Complete reference of the Sda Provision Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_provisioned_wired_device + - Paths used are get /dna/intent/api/v1/business/sda/provision-device """ EXAMPLES = r""" diff --git a/plugins/modules/sda_virtual_network.py b/plugins/modules/sda_virtual_network.py index 06c46b0e40..9f0ebaed7f 100644 --- a/plugins/modules/sda_virtual_network.py +++ b/plugins/modules/sda_virtual_network.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Virtual Network description: - Manage operations create and delete of the resource Sda Virtual Network. +- Delete virtual network (VN) from SDA Fabric. +- Add virtual network (VN) in SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +26,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Virtual Network reference - description: Complete reference of the Sda Virtual Network object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_vn + - Paths used are delete /dna/intent/api/v1/business/sda/virtual-network, + post /dna/intent/api/v1/business/sda/virtual-network """ EXAMPLES = r""" diff --git a/plugins/modules/sda_virtual_network_info.py b/plugins/modules/sda_virtual_network_info.py index e173c3d88b..873e0b5475 100644 --- a/plugins/modules/sda_virtual_network_info.py +++ b/plugins/modules/sda_virtual_network_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Virtual Network description: - Get all Sda Virtual Network. +- Get virtual network (VN) from SDA Fabric. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Virtual Network reference - description: Complete reference of the Sda Virtual Network object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_vn + - Paths used are get /dna/intent/api/v1/business/sda/virtual-network """ EXAMPLES = r""" diff --git a/plugins/modules/sda_virtual_network_ip_pool.py b/plugins/modules/sda_virtual_network_ip_pool.py index 654f9ce579..6a66708e8a 100644 --- a/plugins/modules/sda_virtual_network_ip_pool.py +++ b/plugins/modules/sda_virtual_network_ip_pool.py @@ -10,6 +10,8 @@ short_description: Resource module for Sda Virtual Network Ip Pool description: - Manage operations create and delete of the resource Sda Virtual Network Ip Pool. +- Delete IP Pool from SDA Virtual Network. +- Add IP Pool in SDA Virtual Network. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -63,11 +65,11 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Virtual Network Ip Pool reference - description: Complete reference of the Sda Virtual Network Ip Pool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_ip_pool_in_sda_virtual_network + - Paths used are delete /dna/intent/api/v1/business/sda/virtualnetwork/ippool, + post /dna/intent/api/v1/business/sda/virtualnetwork/ippool """ EXAMPLES = r""" diff --git a/plugins/modules/sda_virtual_network_ip_pool_info.py b/plugins/modules/sda_virtual_network_ip_pool_info.py index a719fc881a..fe5f19e66d 100644 --- a/plugins/modules/sda_virtual_network_ip_pool_info.py +++ b/plugins/modules/sda_virtual_network_ip_pool_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Virtual Network Ip Pool description: - Get all Sda Virtual Network Ip Pool. +- Get IP Pool from SDA Virtual Network. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -29,11 +30,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Virtual Network Ip Pool reference - description: Complete reference of the Sda Virtual Network Ip Pool object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_ip_pool_from_sda_virtual_network + - Paths used are get /dna/intent/api/v1/business/sda/virtualnetwork/ippool """ EXAMPLES = r""" diff --git a/plugins/modules/sda_virtual_network_v2.py b/plugins/modules/sda_virtual_network_v2.py index e58249a74b..13d4ca6a88 100644 --- a/plugins/modules/sda_virtual_network_v2.py +++ b/plugins/modules/sda_virtual_network_v2.py @@ -10,6 +10,9 @@ short_description: Resource module for Sda Virtual Network V2 description: - Manage operations create, update and delete of the resource Sda Virtual Network V2. +- Add virtual network with scalable groups at global level. +- Delete virtual network with scalable groups. +- Update virtual network with scalable groups. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -31,11 +34,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Virtual Network V2 reference - description: Complete reference of the Sda Virtual Network V2 object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.add_virtual_network_with_scalable_groups, + sda.Sda.update_virtual_network_with_scalable_groups + - Paths used are post /dna/intent/api/v1/virtual-network, + delete /dna/intent/api/v1/virtual-network, + put /dna/intent/api/v1/virtual-network """ EXAMPLES = r""" diff --git a/plugins/modules/sda_virtual_network_v2_info.py b/plugins/modules/sda_virtual_network_v2_info.py index a7dd3fb122..6b63d85951 100644 --- a/plugins/modules/sda_virtual_network_v2_info.py +++ b/plugins/modules/sda_virtual_network_v2_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sda Virtual Network V2 description: - Get all Sda Virtual Network V2. +- Get virtual network with scalable groups. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sda Virtual Network V2 reference - description: Complete reference of the Sda Virtual Network V2 object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sda.Sda.get_virtual_network_with_scalable_groups + - Paths used are get /dna/intent/api/v1/virtual-network """ EXAMPLES = r""" diff --git a/plugins/modules/security_advisories_devices_info.py b/plugins/modules/security_advisories_devices_info.py index bf67fe477e..c30dc7fe1e 100644 --- a/plugins/modules/security_advisories_devices_info.py +++ b/plugins/modules/security_advisories_devices_info.py @@ -10,6 +10,7 @@ short_description: Information module for Security Advisories Devices description: - Get all Security Advisories Devices. +- Retrieves list of devices for an advisory. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Security Advisories Devices reference - description: Complete reference of the Security Advisories Devices object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + security_advisories.SecurityAdvisories.get_devices_per_advisory + - Paths used are get /dna/intent/api/v1/security-advisory/advisory/{advisoryId}/device """ EXAMPLES = r""" diff --git a/plugins/modules/security_advisories_ids_per_device_info.py b/plugins/modules/security_advisories_ids_per_device_info.py index c4ce459ef3..84b84aa6c2 100644 --- a/plugins/modules/security_advisories_ids_per_device_info.py +++ b/plugins/modules/security_advisories_ids_per_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Security Advisories Ids Per Device description: - Get Security Advisories Ids Per Device by id. +- Retrieves list of advisory IDs for a device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Security Advisories Ids Per Device reference - description: Complete reference of the Security Advisories Ids Per Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + security_advisories.SecurityAdvisories.get_advisory_ids_per_device + - Paths used are get /dna/intent/api/v1/security-advisory/device/{deviceId} """ EXAMPLES = r""" diff --git a/plugins/modules/security_advisories_info.py b/plugins/modules/security_advisories_info.py index 10e12fb20f..dd4ab35785 100644 --- a/plugins/modules/security_advisories_info.py +++ b/plugins/modules/security_advisories_info.py @@ -10,6 +10,7 @@ short_description: Information module for Security Advisories description: - Get all Security Advisories. +- Retrieves list of advisories on the network. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Security Advisories reference - description: Complete reference of the Security Advisories object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + security_advisories.SecurityAdvisories.get_advisories_list + - Paths used are get /dna/intent/api/v1/security-advisory/advisory """ EXAMPLES = r""" diff --git a/plugins/modules/security_advisories_per_device_info.py b/plugins/modules/security_advisories_per_device_info.py index 376c42dea0..102a67611b 100644 --- a/plugins/modules/security_advisories_per_device_info.py +++ b/plugins/modules/security_advisories_per_device_info.py @@ -10,6 +10,7 @@ short_description: Information module for Security Advisories Per Device description: - Get all Security Advisories Per Device. +- Retrieves list of advisories for a device. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Security Advisories Per Device reference - description: Complete reference of the Security Advisories Per Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + security_advisories.SecurityAdvisories.get_advisories_per_device + - Paths used are get /dna/intent/api/v1/security-advisory/device/{deviceId}/advisory """ EXAMPLES = r""" diff --git a/plugins/modules/security_advisories_summary_info.py b/plugins/modules/security_advisories_summary_info.py index c326f69f67..fb5c7b6b80 100644 --- a/plugins/modules/security_advisories_summary_info.py +++ b/plugins/modules/security_advisories_summary_info.py @@ -10,6 +10,7 @@ short_description: Information module for Security Advisories Summary description: - Get all Security Advisories Summary. +- Retrieves summary of advisories on the network. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Security Advisories Summary reference - description: Complete reference of the Security Advisories Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + security_advisories.SecurityAdvisories.get_advisories_summary + - Paths used are get /dna/intent/api/v1/security-advisory/advisory/aggregate """ EXAMPLES = r""" diff --git a/plugins/modules/sensor.py b/plugins/modules/sensor.py index cb046f8167..2cdc33c52b 100644 --- a/plugins/modules/sensor.py +++ b/plugins/modules/sensor.py @@ -10,6 +10,8 @@ short_description: Resource module for Sensor description: - Manage operations create and delete of the resource Sensor. +- Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID. +- Intent API to delete an existing SENSOR test template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -84,11 +86,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sensor reference - description: Complete reference of the Sensor object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sensors.Sensors.create_sensor_test_template, + sensors.Sensors.delete_sensor_test + - Paths used are post /dna/intent/api/v1/sensor, + delete /dna/intent/api/v1/sensor """ EXAMPLES = r""" diff --git a/plugins/modules/sensor_info.py b/plugins/modules/sensor_info.py index a2a2ecceae..c124597a7a 100644 --- a/plugins/modules/sensor_info.py +++ b/plugins/modules/sensor_info.py @@ -10,6 +10,7 @@ short_description: Information module for Sensor description: - Get all Sensor. +- Intent API to get a list of SENSOR devices. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sensor reference - description: Complete reference of the Sensor object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sensors.Sensors.sensors + - Paths used are get /dna/intent/api/v1/sensor """ EXAMPLES = r""" diff --git a/plugins/modules/sensor_test_run.py b/plugins/modules/sensor_test_run.py index ac5c73e8c8..d28820db11 100644 --- a/plugins/modules/sensor_test_run.py +++ b/plugins/modules/sensor_test_run.py @@ -10,6 +10,7 @@ short_description: Resource module for Sensor Test Run description: - Manage operation update of the resource Sensor Test Run. +- Intent API to run a deployed SENSOR test. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sensor Test Run reference - description: Complete reference of the Sensor Test Run object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sensors.Sensors.run_now_sensor_test + - Paths used are put /dna/intent/api/v1/sensor-run-now """ EXAMPLES = r""" diff --git a/plugins/modules/sensor_test_template_duplicate.py b/plugins/modules/sensor_test_template_duplicate.py index 30bd7fb263..41682f86d7 100644 --- a/plugins/modules/sensor_test_template_duplicate.py +++ b/plugins/modules/sensor_test_template_duplicate.py @@ -10,6 +10,7 @@ short_description: Resource module for Sensor Test Template Duplicate description: - Manage operation update of the resource Sensor Test Template Duplicate. +- Intent API to duplicate an existing SENSOR test template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sensor Test Template Duplicate reference - description: Complete reference of the Sensor Test Template Duplicate object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sensors.Sensors.duplicate_sensor_test_template + - Paths used are put /dna/intent/api/v1/sensorTestTemplate """ EXAMPLES = r""" diff --git a/plugins/modules/sensor_test_template_edit.py b/plugins/modules/sensor_test_template_edit.py index 1622055743..0029c1bb37 100644 --- a/plugins/modules/sensor_test_template_edit.py +++ b/plugins/modules/sensor_test_template_edit.py @@ -10,6 +10,7 @@ short_description: Resource module for Sensor Test Template Edit description: - Manage operation update of the resource Sensor Test Template Edit. +- Intent API to deploy, schedule, or edit and existing SENSOR test template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -81,11 +82,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Sensor Test Template Edit reference - description: Complete reference of the Sensor Test Template Edit object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sensors.Sensors.edit_sensor_test_template + - Paths used are put /dna/intent/api/v1/AssuranceScheduleSensorTest """ EXAMPLES = r""" diff --git a/plugins/modules/service_provider_create.py b/plugins/modules/service_provider_create.py index 621c3efd39..be6e310e0f 100644 --- a/plugins/modules/service_provider_create.py +++ b/plugins/modules/service_provider_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Service Provider Create description: - Manage operation create of the resource Service Provider Create. +- API to create service provider profile(QOS). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -35,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Service Provider Create reference - description: Complete reference of the Service Provider Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.create_sp_profile + - Paths used are post /dna/intent/api/v1/service-provider """ EXAMPLES = r""" diff --git a/plugins/modules/service_provider_info.py b/plugins/modules/service_provider_info.py index 9327e23fea..634e236e37 100644 --- a/plugins/modules/service_provider_info.py +++ b/plugins/modules/service_provider_info.py @@ -10,6 +10,7 @@ short_description: Information module for Service Provider description: - Get all Service Provider. +- API to get service provider details (QoS). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Service Provider reference - description: Complete reference of the Service Provider object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.get_service_provider_details + - Paths used are get /dna/intent/api/v1/service-provider """ EXAMPLES = r""" diff --git a/plugins/modules/service_provider_profile_delete.py b/plugins/modules/service_provider_profile_delete.py index ddf492e868..fcdd45df70 100644 --- a/plugins/modules/service_provider_profile_delete.py +++ b/plugins/modules/service_provider_profile_delete.py @@ -10,6 +10,7 @@ short_description: Resource module for Service Provider Profile Delete description: - Manage operation delete of the resource Service Provider Profile Delete. +- API to delete Service Provider profile (QoS). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Service Provider Profile Delete reference - description: Complete reference of the Service Provider Profile Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.delete_sp_profile + - Paths used are delete /dna/intent/api/v1/sp-profile/{spProfileName} """ EXAMPLES = r""" diff --git a/plugins/modules/service_provider_update.py b/plugins/modules/service_provider_update.py index 82f5474b49..3f17573cc6 100644 --- a/plugins/modules/service_provider_update.py +++ b/plugins/modules/service_provider_update.py @@ -10,6 +10,7 @@ short_description: Resource module for Service Provider Update description: - Manage operation update of the resource Service Provider Update. +- API to update SP profile. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -35,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Service Provider Update reference - description: Complete reference of the Service Provider Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.update_sp_profile + - Paths used are put /dna/intent/api/v1/service-provider """ EXAMPLES = r""" diff --git a/plugins/modules/site_assign_credential.py b/plugins/modules/site_assign_credential.py index 6689ed53e4..f7fd14a705 100644 --- a/plugins/modules/site_assign_credential.py +++ b/plugins/modules/site_assign_credential.py @@ -10,6 +10,7 @@ short_description: Resource module for Site Assign Credential description: - Manage operation create of the resource Site Assign Credential. +- Assign Device Credential To Site. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -39,11 +40,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Assign Credential reference - description: Complete reference of the Site Assign Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + network_settings.NetworkSettings.assign_credential_to_site + - Paths used are post /dna/intent/api/v1/credential-to-site/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/site_assign_device.py b/plugins/modules/site_assign_device.py index a5543dbe8c..8e41d553d4 100644 --- a/plugins/modules/site_assign_device.py +++ b/plugins/modules/site_assign_device.py @@ -10,6 +10,7 @@ short_description: Resource module for Site Assign Device description: - Manage operation create of the resource Site Assign Device. +- Assigns list of devices to a site. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -28,11 +29,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Assign Device reference - description: Complete reference of the Site Assign Device object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.assign_device_to_site + - Paths used are post /dna/system/api/v1/site/{siteId}/device """ EXAMPLES = r""" diff --git a/plugins/modules/site_count_info.py b/plugins/modules/site_count_info.py index c05a727d20..4a86c145f1 100644 --- a/plugins/modules/site_count_info.py +++ b/plugins/modules/site_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Site Count description: - Get all Site Count. +- API to get site count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Count reference - description: Complete reference of the Site Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.get_site_count + - Paths used are get /dna/intent/api/v1/site/count """ EXAMPLES = r""" diff --git a/plugins/modules/site_create.py b/plugins/modules/site_create.py index 7f779de1db..921d98c5f8 100644 --- a/plugins/modules/site_create.py +++ b/plugins/modules/site_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Site Create description: - Manage operation create of the resource Site Create. +- Creates site with area/building/floor with specified hierarchy. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -77,11 +78,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Create reference - description: Complete reference of the Site Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.create_site + - Paths used are post /dna/intent/api/v1/site """ EXAMPLES = r""" diff --git a/plugins/modules/site_delete.py b/plugins/modules/site_delete.py index b958d2d5e8..a0ac698a3c 100644 --- a/plugins/modules/site_delete.py +++ b/plugins/modules/site_delete.py @@ -10,6 +10,7 @@ short_description: Resource module for Site Delete description: - Manage operation delete of the resource Site Delete. +- Delete site with area/building/floor by siteId. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Delete reference - description: Complete reference of the Site Delete object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.delete_site + - Paths used are delete /dna/intent/api/v1/site/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/site_design_floormap.py b/plugins/modules/site_design_floormap.py index 6910fd3c69..cc486754f2 100644 --- a/plugins/modules/site_design_floormap.py +++ b/plugins/modules/site_design_floormap.py @@ -10,6 +10,8 @@ short_description: Resource module for Site Design Floormap description: - Manage operations create, update and delete of the resource Site Design Floormap. +- Service to create a floor map with callback. +- Service to delete an (empty) floor map with callback. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +26,13 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Design Floormap reference - description: Complete reference of the Site Design Floormap object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.update_floormap, + site_design.SiteDesign.create_floormap, + site_design.SiteDesign.delete_floormap + - Paths used are post /dna/intent/api/v1/wireless/floormap, + delete /dna/intent/api/v1/wireless/floormap/{floorId} """ EXAMPLES = r""" diff --git a/plugins/modules/site_design_floormap_info.py b/plugins/modules/site_design_floormap_info.py index 30b17e4ea0..6a74dd8cbf 100644 --- a/plugins/modules/site_design_floormap_info.py +++ b/plugins/modules/site_design_floormap_info.py @@ -9,7 +9,10 @@ module: site_design_floormap_info short_description: Information module for Site Design Floormap description: +- Get all Site Design Floormap. - Get Site Design Floormap by id. +- List all floor maps. +- List specified floor map(s). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,14 +28,28 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Design Floormap reference - description: Complete reference of the Site Design Floormap object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + site_design.SiteDesign.get_floormaps, + site_design.SiteDesign.get_floormap + - Paths used are get /dna/intent/api/v1/wireless/floormap/all, + get /dna/intent/api/v1/wireless/floormap/{floorId} """ EXAMPLES = r""" +- name: Get all Site Design Floormap + cisco.dnac.site_design_floormap_info: + dnac_host: "{{dnac_host}}" + dnac_username: "{{dnac_username}}" + dnac_password: "{{dnac_password}}" + dnac_verify: "{{dnac_verify}}" + dnac_port: "{{dnac_port}}" + dnac_version: "{{dnac_version}}" + dnac_debug: "{{dnac_debug}}" + headers: + custom: value + register: result + - name: Get Site Design Floormap by id cisco.dnac.site_design_floormap_info: dnac_host: "{{dnac_host}}" diff --git a/plugins/modules/site_health_info.py b/plugins/modules/site_health_info.py index 0eb46c30a4..4f27ad209d 100644 --- a/plugins/modules/site_health_info.py +++ b/plugins/modules/site_health_info.py @@ -10,6 +10,7 @@ short_description: Information module for Site Health description: - Get all Site Health. +- Returns Overall Health information for all sites. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -38,11 +39,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Health reference - description: Complete reference of the Site Health object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.get_site_health + - Paths used are get /dna/intent/api/v1/site-health """ EXAMPLES = r""" diff --git a/plugins/modules/site_info.py b/plugins/modules/site_info.py index 5f867c2816..e8345e2350 100644 --- a/plugins/modules/site_info.py +++ b/plugins/modules/site_info.py @@ -10,6 +10,7 @@ short_description: Information module for Site description: - Get all Site. +- Get site using siteNameHierarchy/siteId/type ,return all sites if these parameters are not given as input. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site reference - description: Complete reference of the Site object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.get_site + - Paths used are get /dna/intent/api/v1/site """ EXAMPLES = r""" diff --git a/plugins/modules/site_membership_info.py b/plugins/modules/site_membership_info.py index e206153ac6..91f5748218 100644 --- a/plugins/modules/site_membership_info.py +++ b/plugins/modules/site_membership_info.py @@ -10,6 +10,7 @@ short_description: Information module for Site Membership description: - Get Site Membership by id. +- Getting the site children details and device details. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Membership reference - description: Complete reference of the Site Membership object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.get_membership + - Paths used are get /dna/intent/api/v1/membership/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/site_update.py b/plugins/modules/site_update.py index cdc080c788..5a5ccdad48 100644 --- a/plugins/modules/site_update.py +++ b/plugins/modules/site_update.py @@ -10,6 +10,7 @@ short_description: Resource module for Site Update description: - Manage operation update of the resource Site Update. +- Update site area/building/floor with specified hierarchy and new values. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -77,11 +78,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Site Update reference - description: Complete reference of the Site Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + sites.Sites.update_site + - Paths used are put /dna/intent/api/v1/site/{siteId} """ EXAMPLES = r""" diff --git a/plugins/modules/snmp_properties.py b/plugins/modules/snmp_properties.py index 72ab8d7326..f4727cdfee 100644 --- a/plugins/modules/snmp_properties.py +++ b/plugins/modules/snmp_properties.py @@ -10,6 +10,7 @@ short_description: Resource module for Snmp Properties description: - Manage operation create of the resource Snmp Properties. +- Adds SNMP properties. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -37,11 +38,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Snmp Properties reference - description: Complete reference of the Snmp Properties object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.create_update_snmp_properties + - Paths used are post /dna/intent/api/v1/snmp-property """ EXAMPLES = r""" diff --git a/plugins/modules/snmp_properties_info.py b/plugins/modules/snmp_properties_info.py index 274316d558..6995906ce8 100644 --- a/plugins/modules/snmp_properties_info.py +++ b/plugins/modules/snmp_properties_info.py @@ -10,6 +10,7 @@ short_description: Information module for Snmp Properties description: - Get all Snmp Properties. +- Returns SNMP properties. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Snmp Properties reference - description: Complete reference of the Snmp Properties object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.get_snmp_properties + - Paths used are get /dna/intent/api/v1/snmp-property """ EXAMPLES = r""" diff --git a/plugins/modules/snmpv2_read_community_credential.py b/plugins/modules/snmpv2_read_community_credential.py index 97279020b7..ec624274c5 100644 --- a/plugins/modules/snmpv2_read_community_credential.py +++ b/plugins/modules/snmpv2_read_community_credential.py @@ -10,6 +10,8 @@ short_description: Resource module for Snmpv2 Read Community Credential description: - Manage operations create and update of the resource Snmpv2 Read Community Credential. +- Updates global SNMP read community. +- Adds global SNMP read community. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -49,11 +51,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Snmpv2 Read Community Credential reference - description: Complete reference of the Snmpv2 Read Community Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.update_snmp_read_community, + discovery.Discovery.create_snmp_read_community + - Paths used are put /dna/intent/api/v1/global-credential/snmpv2-read-community, + post /dna/intent/api/v1/global-credential/snmpv2-read-community """ EXAMPLES = r""" diff --git a/plugins/modules/snmpv2_write_community_credential.py b/plugins/modules/snmpv2_write_community_credential.py index 1e7a156cb8..d8b180d830 100644 --- a/plugins/modules/snmpv2_write_community_credential.py +++ b/plugins/modules/snmpv2_write_community_credential.py @@ -10,6 +10,8 @@ short_description: Resource module for Snmpv2 Write Community Credential description: - Manage operations create and update of the resource Snmpv2 Write Community Credential. +- Adds global SNMP write community. +- Updates global SNMP write community. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -49,11 +51,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Snmpv2 Write Community Credential reference - description: Complete reference of the Snmpv2 Write Community Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.create_snmp_write_community, + discovery.Discovery.update_snmp_write_community + - Paths used are post /dna/intent/api/v1/global-credential/snmpv2-write-community, + put /dna/intent/api/v1/global-credential/snmpv2-write-community """ EXAMPLES = r""" diff --git a/plugins/modules/snmpv3_credential.py b/plugins/modules/snmpv3_credential.py index 70339285b3..5d9e22eddd 100644 --- a/plugins/modules/snmpv3_credential.py +++ b/plugins/modules/snmpv3_credential.py @@ -10,6 +10,8 @@ short_description: Resource module for Snmpv3 Credential description: - Manage operations create and update of the resource Snmpv3 Credential. +- Updates global SNMPv3 credential. +- Adds global SNMPv3 credentials. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -54,11 +56,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Snmpv3 Credential reference - description: Complete reference of the Snmpv3 Credential object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + discovery.Discovery.create_snmpv3_credentials, + discovery.Discovery.update_snmpv3_credentials + - Paths used are put /dna/intent/api/v1/global-credential/snmpv3, + post /dna/intent/api/v1/global-credential/snmpv3 """ EXAMPLES = r""" diff --git a/plugins/modules/swim_image_details_info.py b/plugins/modules/swim_image_details_info.py index 229fb9e362..5a9e900923 100644 --- a/plugins/modules/swim_image_details_info.py +++ b/plugins/modules/swim_image_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Swim Image Details description: - Get all Swim Image Details. +- Returns software image list based on a filter criteria. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -93,11 +94,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Swim Image Details reference - description: Complete reference of the Swim Image Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.get_software_image_details + - Paths used are get /dna/intent/api/v1/image/importation """ EXAMPLES = r""" diff --git a/plugins/modules/swim_import_local.py b/plugins/modules/swim_import_local.py index 034b82daae..3ac05441f2 100644 --- a/plugins/modules/swim_import_local.py +++ b/plugins/modules/swim_import_local.py @@ -10,6 +10,8 @@ short_description: Resource module for Swim Import Local description: - Manage operation create of the resource Swim Import Local. +- Fetches a software image from local file system and uploads to DNA Center. + Supported software image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -34,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Swim Import Local reference - description: Complete reference of the Swim Import Local object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.import_local_software_image + - Paths used are post /dna/intent/api/v1/image/importation/source/file """ EXAMPLES = r""" diff --git a/plugins/modules/swim_import_via_url.py b/plugins/modules/swim_import_via_url.py index 3f911ad5f5..805b54527b 100644 --- a/plugins/modules/swim_import_via_url.py +++ b/plugins/modules/swim_import_via_url.py @@ -10,6 +10,8 @@ short_description: Resource module for Swim Import Via Url description: - Manage operation create of the resource Swim Import Via Url. +- Fetches a software image from remote file system (using URL for HTTP/FTP) and uploads to DNA Center. + Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -47,11 +49,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Swim Import Via Url reference - description: Complete reference of the Swim Import Via Url object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.import_software_image_via_url + - Paths used are post /dna/intent/api/v1/image/importation/source/url """ EXAMPLES = r""" diff --git a/plugins/modules/swim_trigger_activation.py b/plugins/modules/swim_trigger_activation.py index 4e0e87157e..6e5799c3fc 100644 --- a/plugins/modules/swim_trigger_activation.py +++ b/plugins/modules/swim_trigger_activation.py @@ -10,6 +10,7 @@ short_description: Resource module for Swim Trigger Activation description: - Manage operation create of the resource Swim Trigger Activation. +- Activates a software image on a given device. Software image must be present in the device flash. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -46,11 +47,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Swim Trigger Activation reference - description: Complete reference of the Swim Trigger Activation object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.trigger_software_image_activation + - Paths used are post /dna/intent/api/v1/image/activation/device """ EXAMPLES = r""" diff --git a/plugins/modules/swim_trigger_distribution.py b/plugins/modules/swim_trigger_distribution.py index ca0776b5ff..e3766c4803 100644 --- a/plugins/modules/swim_trigger_distribution.py +++ b/plugins/modules/swim_trigger_distribution.py @@ -10,6 +10,7 @@ short_description: Resource module for Swim Trigger Distribution description: - Manage operation create of the resource Swim Trigger Distribution. +- Distributes a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -28,11 +29,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Swim Trigger Distribution reference - description: Complete reference of the Swim Trigger Distribution object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + software_image_management_swim.SoftwareImageManagementSwim.trigger_software_image_distribution + - Paths used are post /dna/intent/api/v1/image/distribution """ EXAMPLES = r""" diff --git a/plugins/modules/system_health_count_info.py b/plugins/modules/system_health_count_info.py index 7b35f1641d..87db6d4e3f 100644 --- a/plugins/modules/system_health_count_info.py +++ b/plugins/modules/system_health_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for System Health Count description: - Get all System Health Count. +- This API gives the count of the latest system events. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -33,11 +34,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: System Health Count reference - description: Complete reference of the System Health Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + health_and_performance.HealthAndPerformance.system_health_count + - Paths used are get /dna/intent/api/v1/diagnostics/system/health/count """ EXAMPLES = r""" diff --git a/plugins/modules/system_health_info.py b/plugins/modules/system_health_info.py index c1fdee4583..fefc7ac290 100644 --- a/plugins/modules/system_health_info.py +++ b/plugins/modules/system_health_info.py @@ -10,6 +10,7 @@ short_description: Information module for System Health description: - Get all System Health. +- This API retrieves the latest system events. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -45,11 +46,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: System Health reference - description: Complete reference of the System Health object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + health_and_performance.HealthAndPerformance.system_health + - Paths used are get /dna/intent/api/v1/diagnostics/system/health """ EXAMPLES = r""" diff --git a/plugins/modules/system_performance_historical_info.py b/plugins/modules/system_performance_historical_info.py index c0403a1cfe..7b9a3ef02a 100644 --- a/plugins/modules/system_performance_historical_info.py +++ b/plugins/modules/system_performance_historical_info.py @@ -10,6 +10,7 @@ short_description: Information module for System Performance Historical description: - Get all System Performance Historical. +- This API retrieves the historical performance indicators . The data can be retrieved for the last 3 months. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -37,11 +38,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: System Performance Historical reference - description: Complete reference of the System Performance Historical object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + health_and_performance.HealthAndPerformance.system_performance_historical + - Paths used are get /dna/intent/api/v1/diagnostics/system/performance/history """ EXAMPLES = r""" diff --git a/plugins/modules/system_performance_info.py b/plugins/modules/system_performance_info.py index 5a1674ec17..7209482f40 100644 --- a/plugins/modules/system_performance_info.py +++ b/plugins/modules/system_performance_info.py @@ -10,6 +10,7 @@ short_description: Information module for System Performance description: - Get all System Performance. +- This API gives the aggregated performance indicators. The data can be retrieved for the last 3 months. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -41,11 +42,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: System Performance reference - description: Complete reference of the System Performance object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + health_and_performance.HealthAndPerformance.system_performance + - Paths used are get /dna/intent/api/v1/diagnostics/system/performance """ EXAMPLES = r""" diff --git a/plugins/modules/tag.py b/plugins/modules/tag.py index da4387281f..8b3b1f57c7 100644 --- a/plugins/modules/tag.py +++ b/plugins/modules/tag.py @@ -10,6 +10,9 @@ short_description: Resource module for Tag description: - Manage operations create, update and delete of the resource Tag. +- Updates a tag specified by id. +- Creates tag with specified tag attributes. +- Deletes a tag specified by id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -61,11 +64,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag reference - description: Complete reference of the Tag object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.update_tag, + tag.Tag.delete_tag, + tag.Tag.create_tag + - Paths used are put /dna/intent/api/v1/tag, + post /dna/intent/api/v1/tag, + delete /dna/intent/api/v1/tag/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/tag_count_info.py b/plugins/modules/tag_count_info.py index 4cb884f83d..e356424186 100644 --- a/plugins/modules/tag_count_info.py +++ b/plugins/modules/tag_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Tag Count description: - Get all Tag Count. +- Returns tag count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -45,11 +46,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag Count reference - description: Complete reference of the Tag Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.get_tag_count + - Paths used are get /dna/intent/api/v1/tag/count """ EXAMPLES = r""" diff --git a/plugins/modules/tag_info.py b/plugins/modules/tag_info.py index b87fc60d0e..01364bfa3c 100644 --- a/plugins/modules/tag_info.py +++ b/plugins/modules/tag_info.py @@ -11,6 +11,8 @@ description: - Get all Tag. - Get Tag by id. +- Returns the tags for given filter criteria. +- Returns tag specified by Id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -72,11 +74,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag reference - description: Complete reference of the Tag object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.get_tag_by_id, + tag.Tag.get_tag + - Paths used are get /dna/intent/api/v1/tag, + get /dna/intent/api/v1/tag/{id} """ EXAMPLES = r""" diff --git a/plugins/modules/tag_member.py b/plugins/modules/tag_member.py index 20a3cba6d1..85428d7328 100644 --- a/plugins/modules/tag_member.py +++ b/plugins/modules/tag_member.py @@ -10,6 +10,8 @@ short_description: Resource module for Tag Member description: - Manage operations create and delete of the resource Tag Member. +- Adds members to the tag specified by id. +- Removes Tag member from the tag specified by id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -27,11 +29,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag Member reference - description: Complete reference of the Tag Member object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.remove_tag_member, + tag.Tag.add_members_to_the_tag + - Paths used are post /dna/intent/api/v1/tag/{id}/member, + delete /dna/intent/api/v1/tag/{id}/member/{memberId} """ EXAMPLES = r""" diff --git a/plugins/modules/tag_member_count_info.py b/plugins/modules/tag_member_count_info.py index 3af328fe96..bb84236493 100644 --- a/plugins/modules/tag_member_count_info.py +++ b/plugins/modules/tag_member_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Tag Member Count description: - Get all Tag Member Count. +- Returns the number of members in a given tag. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -37,11 +38,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag Member Count reference - description: Complete reference of the Tag Member Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.get_tag_member_count + - Paths used are get /dna/intent/api/v1/tag/{id}/member/count """ EXAMPLES = r""" diff --git a/plugins/modules/tag_member_info.py b/plugins/modules/tag_member_info.py index 6b3474da95..2f2640acf8 100644 --- a/plugins/modules/tag_member_info.py +++ b/plugins/modules/tag_member_info.py @@ -10,6 +10,7 @@ short_description: Information module for Tag Member description: - Get all Tag Member. +- Returns tag members specified by id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -51,11 +52,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag Member reference - description: Complete reference of the Tag Member object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.get_tag_members_by_id + - Paths used are get /dna/intent/api/v1/tag/{id}/member """ EXAMPLES = r""" diff --git a/plugins/modules/tag_member_type_info.py b/plugins/modules/tag_member_type_info.py index f19de77589..e1257a7b57 100644 --- a/plugins/modules/tag_member_type_info.py +++ b/plugins/modules/tag_member_type_info.py @@ -10,6 +10,7 @@ short_description: Information module for Tag Member Type description: - Get all Tag Member Type. +- Returns list of supported resource types. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag Member Type reference - description: Complete reference of the Tag Member Type object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.get_tag_resource_types + - Paths used are get /dna/intent/api/v1/tag/member/type """ EXAMPLES = r""" diff --git a/plugins/modules/tag_membership.py b/plugins/modules/tag_membership.py index d181c02e5a..d13bcf0c30 100644 --- a/plugins/modules/tag_membership.py +++ b/plugins/modules/tag_membership.py @@ -10,6 +10,9 @@ short_description: Resource module for Tag Membership description: - Manage operation update of the resource Tag Membership. +- Updates tag membership. As part of the request payload through this API, + only the specified members are added / retained to the given input tags. + Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -29,11 +32,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Tag Membership reference - description: Complete reference of the Tag Membership object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + tag.Tag.updates_tag_membership + - Paths used are put /dna/intent/api/v1/tag/member """ EXAMPLES = r""" diff --git a/plugins/modules/task_count_info.py b/plugins/modules/task_count_info.py index a7bd900e8e..a3f097cc02 100644 --- a/plugins/modules/task_count_info.py +++ b/plugins/modules/task_count_info.py @@ -10,6 +10,7 @@ short_description: Information module for Task Count description: - Get all Task Count. +- Returns Task count. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -61,11 +62,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Task Count reference - description: Complete reference of the Task Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + task.Task.get_task_count + - Paths used are get /dna/intent/api/v1/task/count """ EXAMPLES = r""" diff --git a/plugins/modules/task_info.py b/plugins/modules/task_info.py index b0dd901be3..d4375aa235 100644 --- a/plugins/modules/task_info.py +++ b/plugins/modules/task_info.py @@ -11,6 +11,8 @@ description: - Get all Task. - Get Task by id. +- Returns task(s) based on filter criteria. +- Returns a task by specified id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -82,11 +84,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Task reference - description: Complete reference of the Task object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + task.Task.get_tasks, + task.Task.get_task_by_id + - Paths used are get /dna/intent/api/v1/task, + get /dna/intent/api/v1/task/{taskId} """ EXAMPLES = r""" diff --git a/plugins/modules/task_operation_info.py b/plugins/modules/task_operation_info.py index 27049469b3..dce5c602d8 100644 --- a/plugins/modules/task_operation_info.py +++ b/plugins/modules/task_operation_info.py @@ -10,6 +10,7 @@ short_description: Information module for Task Operation description: - Get Task Operation by id. +- Returns root tasks associated with an Operationid. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -35,11 +36,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Task Operation reference - description: Complete reference of the Task Operation object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + task.Task.get_task_by_operationid + - Paths used are get /dna/intent/api/v1/task/operation/{operationId}/{offset}/{limit} """ EXAMPLES = r""" diff --git a/plugins/modules/task_tree_info.py b/plugins/modules/task_tree_info.py index 38bf1fe91e..8dcefdbb6d 100644 --- a/plugins/modules/task_tree_info.py +++ b/plugins/modules/task_tree_info.py @@ -10,6 +10,7 @@ short_description: Information module for Task Tree description: - Get all Task Tree. +- Returns a task with its children tasks by based on their id. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Task Tree reference - description: Complete reference of the Task Tree object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + task.Task.get_task_tree + - Paths used are get /dna/intent/api/v1/task/{taskId}/tree """ EXAMPLES = r""" diff --git a/plugins/modules/template_preview.py b/plugins/modules/template_preview.py index a5929431ab..7ce59d9f79 100644 --- a/plugins/modules/template_preview.py +++ b/plugins/modules/template_preview.py @@ -10,6 +10,7 @@ short_description: Resource module for Template Preview description: - Manage operation update of the resource Template Preview. +- API to preview a template. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -31,11 +32,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Template Preview reference - description: Complete reference of the Template Preview object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.preview_template + - Paths used are put /dna/intent/api/v1/template-programmer/template/preview """ EXAMPLES = r""" diff --git a/plugins/modules/templates_details_info.py b/plugins/modules/templates_details_info.py index 3c0f542e89..92fc29cd39 100644 --- a/plugins/modules/templates_details_info.py +++ b/plugins/modules/templates_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Templates Details description: - Get all Templates Details. +- Get template(s) details. version_added: '4.0.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -89,11 +90,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Templates Details reference - description: Complete reference of the Templates Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + configuration_templates.ConfigurationTemplates.get_templates_details + - Paths used are get /dna/intent/api/v2/template-programmer/template """ EXAMPLES = r""" diff --git a/plugins/modules/threat_detail.py b/plugins/modules/threat_detail.py index 2a9d4880b6..06a27a3d53 100644 --- a/plugins/modules/threat_detail.py +++ b/plugins/modules/threat_detail.py @@ -10,6 +10,7 @@ short_description: Resource module for Threat Detail description: - Manage operation create of the resource Threat Detail. +- The details for the Rogue and aWIPS threats. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -45,11 +46,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Threat Detail reference - description: Complete reference of the Threat Detail object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.threat_details + - Paths used are post /dna/intent/api/v1/security/threats/details """ EXAMPLES = r""" diff --git a/plugins/modules/threat_detail_count.py b/plugins/modules/threat_detail_count.py index 8b8a529bde..1cb5b1b535 100644 --- a/plugins/modules/threat_detail_count.py +++ b/plugins/modules/threat_detail_count.py @@ -10,6 +10,7 @@ short_description: Resource module for Threat Detail Count description: - Manage operation create of the resource Threat Detail Count. +- The details count for the Rogue and aWIPS threats. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -45,11 +46,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Threat Detail Count reference - description: Complete reference of the Threat Detail Count object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.threat_detail_count + - Paths used are post /dna/intent/api/v1/security/threats/details/count """ EXAMPLES = r""" diff --git a/plugins/modules/threat_summary.py b/plugins/modules/threat_summary.py index 545c4eb1d8..cd36f5736f 100644 --- a/plugins/modules/threat_summary.py +++ b/plugins/modules/threat_summary.py @@ -10,6 +10,7 @@ short_description: Resource module for Threat Summary description: - Manage operation create of the resource Threat Summary. +- The Threat Summary for the Rogues and aWIPS. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -36,11 +37,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Threat Summary reference - description: Complete reference of the Threat Summary object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + devices.Devices.threat_summary + - Paths used are post /dna/intent/api/v1/security/threats/summary """ EXAMPLES = r""" diff --git a/plugins/modules/topology_layer_2_info.py b/plugins/modules/topology_layer_2_info.py index 24f51538ea..477ae574ba 100644 --- a/plugins/modules/topology_layer_2_info.py +++ b/plugins/modules/topology_layer_2_info.py @@ -10,6 +10,7 @@ short_description: Information module for Topology Layer 2 description: - Get Topology Layer 2 by id. +- Returns Layer 2 network topology by specified VLAN ID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Topology Layer 2 reference - description: Complete reference of the Topology Layer 2 object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + topology.Topology.get_topology_details + - Paths used are get /dna/intent/api/v1/topology/l2/{vlanID} """ EXAMPLES = r""" diff --git a/plugins/modules/topology_layer_3_info.py b/plugins/modules/topology_layer_3_info.py index ee171dd9e4..136a3bc74f 100644 --- a/plugins/modules/topology_layer_3_info.py +++ b/plugins/modules/topology_layer_3_info.py @@ -10,6 +10,7 @@ short_description: Information module for Topology Layer 3 description: - Get Topology Layer 3 by id. +- Returns the Layer 3 network topology by routing protocol. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Topology Layer 3 reference - description: Complete reference of the Topology Layer 3 object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + topology.Topology.get_l3_topology_details + - Paths used are get /dna/intent/api/v1/topology/l3/{topologyType} """ EXAMPLES = r""" diff --git a/plugins/modules/topology_network_health_info.py b/plugins/modules/topology_network_health_info.py index edc09ea382..21e20557b9 100644 --- a/plugins/modules/topology_network_health_info.py +++ b/plugins/modules/topology_network_health_info.py @@ -10,6 +10,7 @@ short_description: Information module for Topology Network Health description: - Get all Topology Network Health. +- Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Topology Network Health reference - description: Complete reference of the Topology Network Health object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + topology.Topology.get_overall_network_health + - Paths used are get /dna/intent/api/v1/network-health """ EXAMPLES = r""" diff --git a/plugins/modules/topology_physical_info.py b/plugins/modules/topology_physical_info.py index 34275693b8..5de12b681f 100644 --- a/plugins/modules/topology_physical_info.py +++ b/plugins/modules/topology_physical_info.py @@ -10,6 +10,7 @@ short_description: Information module for Topology Physical description: - Get all Topology Physical. +- Returns the raw physical topology by specified criteria of nodeType. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Topology Physical reference - description: Complete reference of the Topology Physical object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + topology.Topology.get_physical_topology + - Paths used are get /dna/intent/api/v1/topology/physical-topology """ EXAMPLES = r""" diff --git a/plugins/modules/topology_site_info.py b/plugins/modules/topology_site_info.py index 14488ebf4d..143ecb9811 100644 --- a/plugins/modules/topology_site_info.py +++ b/plugins/modules/topology_site_info.py @@ -10,6 +10,7 @@ short_description: Information module for Topology Site description: - Get all Topology Site. +- Returns site topology. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Topology Site reference - description: Complete reference of the Topology Site object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + topology.Topology.get_site_topology + - Paths used are get /dna/intent/api/v1/topology/site-topology """ EXAMPLES = r""" diff --git a/plugins/modules/topology_vlan_details_info.py b/plugins/modules/topology_vlan_details_info.py index 7cd56c9416..d61e8c1bfc 100644 --- a/plugins/modules/topology_vlan_details_info.py +++ b/plugins/modules/topology_vlan_details_info.py @@ -10,6 +10,7 @@ short_description: Information module for Topology Vlan Details description: - Get all Topology Vlan Details. +- Returns the list of VLAN names. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +22,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Topology Vlan Details reference - description: Complete reference of the Topology Vlan Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + topology.Topology.get_vlan_details + - Paths used are get /dna/intent/api/v1/topology/vlan/vlan-names """ EXAMPLES = r""" diff --git a/plugins/modules/user_enrichment_details_info.py b/plugins/modules/user_enrichment_details_info.py index a66aae78de..1553653c47 100644 --- a/plugins/modules/user_enrichment_details_info.py +++ b/plugins/modules/user_enrichment_details_info.py @@ -10,6 +10,8 @@ short_description: Information module for User Enrichment Details description: - Get all User Enrichment Details. +- Enriches a given network End User context (a network user-id or end user's device Mac Address) + with details about the user and devices that the user is connected to. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -21,11 +23,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: User Enrichment Details reference - description: Complete reference of the User Enrichment Details object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + users.Users.get_user_enrichment_details + - Paths used are get /dna/intent/api/v1/user-enrichment-details """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_dynamic_interface.py b/plugins/modules/wireless_dynamic_interface.py index f11fd294cc..014245397e 100644 --- a/plugins/modules/wireless_dynamic_interface.py +++ b/plugins/modules/wireless_dynamic_interface.py @@ -10,6 +10,8 @@ short_description: Resource module for Wireless Dynamic Interface description: - Manage operations create and delete of the resource Wireless Dynamic Interface. +- API to create or update an dynamic interface. +- Delete a dynamic interface. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +26,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Dynamic Interface reference - description: Complete reference of the Wireless Dynamic Interface object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.create_update_dynamic_interface, + wireless.Wireless.delete_dynamic_interface + - Paths used are post /dna/intent/api/v1/wireless/dynamic-interface, + delete /dna/intent/api/v1/wireless/dynamic-interface/{interfaceName} """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_dynamic_interface_info.py b/plugins/modules/wireless_dynamic_interface_info.py index 8ecdc08e0f..4dde0c98f1 100644 --- a/plugins/modules/wireless_dynamic_interface_info.py +++ b/plugins/modules/wireless_dynamic_interface_info.py @@ -10,6 +10,7 @@ short_description: Information module for Wireless Dynamic Interface description: - Get all Wireless Dynamic Interface. +- Get one or all dynamic interface(s). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Dynamic Interface reference - description: Complete reference of the Wireless Dynamic Interface object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.get_dynamic_interface + - Paths used are get /dna/intent/api/v1/wireless/dynamic-interface """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_enterprise_ssid.py b/plugins/modules/wireless_enterprise_ssid.py index 7c174d49e9..ac600e3da0 100644 --- a/plugins/modules/wireless_enterprise_ssid.py +++ b/plugins/modules/wireless_enterprise_ssid.py @@ -10,6 +10,9 @@ short_description: Resource module for Wireless Enterprise Ssid description: - Manage operations create, update and delete of the resource Wireless Enterprise Ssid. +- Creates enterprise SSID. +- Update enterprise SSID. +- Deletes given enterprise SSID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -76,11 +79,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Enterprise Ssid reference - description: Complete reference of the Wireless Enterprise Ssid object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.create_enterprise_ssid, + wireless.Wireless.delete_enterprise_ssid, + wireless.Wireless.update_enterprise_ssid + - Paths used are post /dna/intent/api/v1/enterprise-ssid, + put /dna/intent/api/v1/enterprise-ssid, + delete /dna/intent/api/v1/enterprise-ssid/{ssidName} """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_enterprise_ssid_info.py b/plugins/modules/wireless_enterprise_ssid_info.py index 78b0a7baad..bbef59fe76 100644 --- a/plugins/modules/wireless_enterprise_ssid_info.py +++ b/plugins/modules/wireless_enterprise_ssid_info.py @@ -10,6 +10,7 @@ short_description: Information module for Wireless Enterprise Ssid description: - Get all Wireless Enterprise Ssid. +- Gets either one or all the enterprise SSID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -27,11 +28,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Enterprise Ssid reference - description: Complete reference of the Wireless Enterprise Ssid object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.get_enterprise_ssid + - Paths used are get /dna/intent/api/v1/enterprise-ssid """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_profile.py b/plugins/modules/wireless_profile.py index db8379e292..806281f00c 100644 --- a/plugins/modules/wireless_profile.py +++ b/plugins/modules/wireless_profile.py @@ -10,6 +10,9 @@ short_description: Resource module for Wireless Profile description: - Manage operations create, update and delete of the resource Wireless Profile. +- Delete the Wireless Profile from DNAC whose name is provided. +- Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. +- Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -58,11 +61,14 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Profile reference - description: Complete reference of the Wireless Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.delete_wireless_profile, + wireless.Wireless.create_wireless_profile, + wireless.Wireless.update_wireless_profile + - Paths used are delete /dna/intent/api/v1/wireless-profile/{wirelessProfileName}, + put /dna/intent/api/v1/wireless/profile, + post /dna/intent/api/v1/wireless/profile """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_profile_info.py b/plugins/modules/wireless_profile_info.py index 5a99d81590..fbb1a545bd 100644 --- a/plugins/modules/wireless_profile_info.py +++ b/plugins/modules/wireless_profile_info.py @@ -10,6 +10,7 @@ short_description: Information module for Wireless Profile description: - Get all Wireless Profile. +- Gets either one or all the wireless network profiles if no name is provided for network-profile. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Profile reference - description: Complete reference of the Wireless Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.get_wireless_profile + - Paths used are get /dna/intent/api/v1/wireless/profile """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_provision_access_point.py b/plugins/modules/wireless_provision_access_point.py index 4927edb192..b28def3ad1 100644 --- a/plugins/modules/wireless_provision_access_point.py +++ b/plugins/modules/wireless_provision_access_point.py @@ -10,6 +10,7 @@ short_description: Resource module for Wireless Provision Access Point description: - Manage operation create of the resource Wireless Provision Access Point. +- Access Point Provision and ReProvision. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -44,11 +45,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Provision Access Point reference - description: Complete reference of the Wireless Provision Access Point object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.ap_provision + - Paths used are post /dna/intent/api/v1/wireless/ap-provision """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_provision_device_create.py b/plugins/modules/wireless_provision_device_create.py index 2265ff4a15..22db490516 100644 --- a/plugins/modules/wireless_provision_device_create.py +++ b/plugins/modules/wireless_provision_device_create.py @@ -10,6 +10,7 @@ short_description: Resource module for Wireless Provision Device Create description: - Manage operation create of the resource Wireless Provision Device Create. +- Provision wireless devices. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -51,11 +52,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Provision Device Create reference - description: Complete reference of the Wireless Provision Device Create object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.provision + - Paths used are post /dna/intent/api/v1/wireless/provision """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_provision_device_update.py b/plugins/modules/wireless_provision_device_update.py index b1dace8f61..172649d3ce 100644 --- a/plugins/modules/wireless_provision_device_update.py +++ b/plugins/modules/wireless_provision_device_update.py @@ -10,6 +10,7 @@ short_description: Resource module for Wireless Provision Device Update description: - Manage operation update of the resource Wireless Provision Device Update. +- Updates wireless provisioning. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -51,11 +52,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Provision Device Update reference - description: Complete reference of the Wireless Provision Device Update object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.provision_update + - Paths used are put /dna/intent/api/v1/wireless/provision """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_provision_ssid_create_provision.py b/plugins/modules/wireless_provision_ssid_create_provision.py index 997b73b49f..1b91c9485d 100644 --- a/plugins/modules/wireless_provision_ssid_create_provision.py +++ b/plugins/modules/wireless_provision_ssid_create_provision.py @@ -10,6 +10,7 @@ short_description: Resource module for Wireless Provision Ssid Create Provision description: - Manage operation create of the resource Wireless Provision Ssid Create Provision. +- Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -75,11 +76,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Provision Ssid Create Provision reference - description: Complete reference of the Wireless Provision Ssid Create Provision object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.create_and_provision_ssid + - Paths used are post /dna/intent/api/v1/business/ssid """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_provision_ssid_delete_reprovision.py b/plugins/modules/wireless_provision_ssid_delete_reprovision.py index 79073ad508..2e95a0f551 100644 --- a/plugins/modules/wireless_provision_ssid_delete_reprovision.py +++ b/plugins/modules/wireless_provision_ssid_delete_reprovision.py @@ -10,6 +10,7 @@ short_description: Resource module for Wireless Provision Ssid Delete Reprovision description: - Manage operation delete of the resource Wireless Provision Ssid Delete Reprovision. +- Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -24,11 +25,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Provision Ssid Delete Reprovision reference - description: Complete reference of the Wireless Provision Ssid Delete Reprovision object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.delete_ssid_and_provision_it_to_devices + - Paths used are delete /dna/intent/api/v1/business/ssid/{ssidName}/{managedAPLocations} """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_psk_override.py b/plugins/modules/wireless_psk_override.py index 095b8f499a..f7e4ffee31 100644 --- a/plugins/modules/wireless_psk_override.py +++ b/plugins/modules/wireless_psk_override.py @@ -10,6 +10,7 @@ short_description: Resource module for Wireless Psk Override description: - Manage operation create of the resource Wireless Psk Override. +- Update/override pass phrase of enterprise SSID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -31,11 +32,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Psk Override reference - description: Complete reference of the Wireless Psk Override object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.psk_override + - Paths used are post /dna/intent/api/v1/wireless/psk-override """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_rf_profile.py b/plugins/modules/wireless_rf_profile.py index cf9cebac81..61038b0118 100644 --- a/plugins/modules/wireless_rf_profile.py +++ b/plugins/modules/wireless_rf_profile.py @@ -10,6 +10,8 @@ short_description: Resource module for Wireless Rf Profile description: - Manage operations create and delete of the resource Wireless Rf Profile. +- Create or Update RF profile. +- Delete RF profile(s). version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module @@ -99,11 +101,12 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Rf Profile reference - description: Complete reference of the Wireless Rf Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.create_or_update_rf_profile, + wireless.Wireless.delete_rf_profiles + - Paths used are post /dna/intent/api/v1/wireless/rf-profile, + delete /dna/intent/api/v1/wireless/rf-profile/{rfProfileName} """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_rf_profile_info.py b/plugins/modules/wireless_rf_profile_info.py index 24e6d9ebbd..2276bed268 100644 --- a/plugins/modules/wireless_rf_profile_info.py +++ b/plugins/modules/wireless_rf_profile_info.py @@ -10,6 +10,7 @@ short_description: Information module for Wireless Rf Profile description: - Get all Wireless Rf Profile. +- Retrieve all RF profiles. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -25,11 +26,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Rf Profile reference - description: Complete reference of the Wireless Rf Profile object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.retrieve_rf_profiles + - Paths used are get /dna/intent/api/v1/wireless/rf-profile """ EXAMPLES = r""" diff --git a/plugins/modules/wireless_sensor_test_results_info.py b/plugins/modules/wireless_sensor_test_results_info.py index a27c246727..b0df3ca05b 100644 --- a/plugins/modules/wireless_sensor_test_results_info.py +++ b/plugins/modules/wireless_sensor_test_results_info.py @@ -10,6 +10,7 @@ short_description: Information module for Wireless Sensor Test Results description: - Get all Wireless Sensor Test Results. +- Intent API to get SENSOR test result summary. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module_info @@ -37,11 +38,10 @@ requirements: - dnacentersdk >= 2.4.0 - python >= 3.5 -seealso: -# Reference by Internet resource -- name: Wireless Sensor Test Results reference - description: Complete reference of the Wireless Sensor Test Results object model. - link: https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary +notes: + - SDK Method used are + wireless.Wireless.sensor_test_results + - Paths used are get /dna/intent/api/v1/AssuranceGetSensorTestResults """ EXAMPLES = r"""