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
cisco-en-programmability · Jan 18, 2022 · 968e83a · 968e83a
1 parent b9c1b67
commit 968e83a
Show file tree

Hide file tree

Showing 327 changed files with 1,948 additions and 1,628 deletions.
diff --git 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
diff --git 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 <[email protected]>

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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"""