Merge pull request #159 from cisco-en-programmability/develop

Develop v6.13.1
cisco-en-programmability · Mar 21, 2024 · e3b0c1c · e3b0c1c
2 parents ca054f1 + 8d256a7
commit e3b0c1c
Show file tree

Hide file tree

Showing 26 changed files with 2,250 additions and 1,955 deletions.
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -834,4 +834,18 @@ releases:
       changes:
         release_summary: Changes the minimum supported version of Ansible to v2.14.0
         minor_changes:
-          - Changes the minimum supported version from Ansible v2.9.10 to v2.14.0
+          - Changes the minimum supported version from Ansible v2.9.10 to v2.14.0
+  6.13.1:
+      release_date: "2024-03-15"
+      changes:
+        release_summary: Enhancements in discovery, site, swim and inventory workflow manager modules.
+        minor_changes:
+          - Introduced sample playbooks for the discovery module.
+          - Resolved a 'NoneType' error in discovery module credentials.
+          - Corrected site creation issues in the site module when optional parameters are missing.
+          - Fixed management IP updates for devices on SNMP version v2.
+          - Addressed image un-tagging issues in inherited site settings.
+          - Provided documentation for EWLC templates in Cisco Catalyst Center version 2.3.7.x.
+          - Added attributes 'dnac_api_task_timeout' and 'dnac_task_poll_interval' in intent and workflow_manager modules.
+          - inventory_workflow_manager - Added attributes 'add_user_defined_field', 'update_interface_details', 'export_device_list' and 'admin_status'
+          - inventory_workflow_manager - Removed attributes 'provision_wireless_device', 'reprovision_wired_device'
diff --git a/galaxy.yml b/galaxy.yml
@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: dnac
-version: 6.13.0
+version: 6.13.1
 readme: README.md
 authors:
   - Rafael Campos <[email protected]>

diff --git a/playbooks/discovery_intent.yml b/playbooks/discovery_intent.yml
@@ -86,7 +86,6 @@
                 auth_password: Lablab#1234
                 privacy_type: AES256
                 privacy_password: Lablab#1234
-                global_cli_len: 3
             protocol_order: ssh
 
     - name: Execute discovery of single device using various discovery specific credentials only
@@ -99,6 +98,7 @@
             discovery_type: "SINGLE"
             ip_address_list:
               - 204.1.2.5
+            use_global_credentials: False
             discovery_specific_credentials:
               cli_credentials_list:
               - username: cisco
@@ -122,11 +122,9 @@
                 auth_password: Lablab#1234
                 privacy_type: AES256
                 privacy_password: Lablab#1234
-                global_cli_len: 3
-            use_global_cred: False
             protocol_order: ssh
 
-    - name: Execute discovery devices using MULTI RANGE with various discovery specific credentials
+    - name: Execute discovery devices using MULTI RANGE with various discovery specific credentials and all global credentials (max 5 allowed)
       cisco.dnac.discovery_intent:
         <<: *dnac_login
         state: merged
@@ -164,7 +162,7 @@
             records_to_return: 1000
             snmp_version: v2
 
-    - name: Execute discovery devices using CDP/LLDP/CIDR
+    - name: Execute discovery devices using CDP/LLDP/CIDR leveraging discovery specific credentials and all the global credentials
       cisco.dnac.discovery_intent:
         <<: *dnac_login
         state: merged

diff --git a/playbooks/discovery_workflow_manager.yml b/playbooks/discovery_workflow_manager.yml
@@ -86,7 +86,6 @@
                 auth_password: Lablab#1234
                 privacy_type: AES256
                 privacy_password: Lablab#1234
-                global_cli_len: 3
             protocol_order: ssh
 
     - name: Execute discovery of single device using various discovery specific credentials only
@@ -99,6 +98,7 @@
             discovery_type: "SINGLE"
             ip_address_list:
               - 204.1.2.5
+            use_global_credentials: False
             discovery_specific_credentials:
               cli_credentials_list:
               - username: cisco
@@ -122,11 +122,9 @@
                 auth_password: Lablab#1234
                 privacy_type: AES256
                 privacy_password: Lablab#1234
-                global_cli_len: 3
-            use_global_cred: False
             protocol_order: ssh
 
-    - name: Execute discovery devices using MULTI RANGE with various discovery specific credentials
+    - name: Execute discovery devices using MULTI RANGE with various discovery specific credentials and all global credentials (max 5 allowed)
       cisco.dnac.discovery_workflow_manager:
         <<: *dnac_login
         state: merged
@@ -164,7 +162,7 @@
             records_to_return: 1000
             snmp_version: v2
 
-    - name: Execute discovery devices using CDP/LLDP/CIDR
+    - name: Execute discovery devices using CDP/LLDP/CIDR leveraging discovery specific credentials and all the global credentials
       cisco.dnac.discovery_workflow_manager:
         <<: *dnac_login
         state: merged

diff --git a/playbooks/inventory_workflow_manager.yml b/playbooks/inventory_workflow_manager.yml
@@ -34,14 +34,12 @@
           snmp_ro_community: "{{item.snmp_ro_community}}"
           snmp_rw_community: "{{item.snmp_rw_community}}"
           snmp_username: "{{item.snmp_username}}"
-          device_updated: "{{item.device_updated}}"
           credential_update: "{{item.credential_update}}"
           clean_config: "{{item.clean_config}}"
           type: "{{item.type}}"
           device_resync: "{{item.device_resync}}"
           reboot_device: "{{item.reboot_device}}"
-          update_device_role:
-            role: "{{item.role}}"
+          role: "{{item.role}}"
           add_user_defined_field:
           - name: Test123
             description: "Added first udf for testing"
@@ -58,36 +56,6 @@
             site_name: "Global/USA/San Francisco/BGL_18/floor_test"
             resync_retry_count: 200
             resync_retry_interval: 2
-          provision_wireless_device:
-          - device_ip: "1.1.1.1"
-            site_name: "Global/USA/BGL_18/floor_pnp"
-            managed_ap_locations: ["Global/USA/BGL_18/floor_pnp", "Global/USA/BGL_18/floor_test"]
-            dynamic_interfaces:
-            - interface_ip_address: 23.23.21.12
-              interface_netmask_in_cidr: 24
-              interface_gateway: "gateway"
-              lag_or_port_number: 12
-              vlan_id: 99
-              interface_name: "etherenet0/0"
-            resync_retry_count: 200
-            resync_retry_interval: 2
-          - device_ip: "2.2.2.2"
-            site_name: "Global/USA/BGL_18/floor_test"
-            managed_ap_locations: ["Global/USA/BGL_19/floor_pnp", "Global/USA/BGL_19/floor_test"]
-            dynamic_interfaces:
-            - interface_ip_address: 32.31.12.23
-              interface_netmask_in_cidr: 26
-              interface_gateway: "gateway_test"
-              lag_or_port_number: 33
-              vlan_id: 78
-              interface_name: "etherenet1/1"
-            resync_retry_count: 200
-            resync_retry_interval: 2
-          reprovision_wired_device:
-          - device_ip: "1.1.1.1"
-            site_name: "Global/USA/San Francisco/BGL_18/floor_pnp"
-          - device_ip: "2.2.2.2"
-            site_name: "Global/USA/San Francisco/BGL_18/floor_test"
           update_interface_details:
             description: "{{item.update_interface_details.description}}"
             interface_name: "{{item.interface_name}}"

diff --git a/playbooks/swim_workflow_manager.yml b/playbooks/swim_workflow_manager.yml
@@ -19,27 +19,29 @@
         dnac_log: True
         dnac_log_level: DEBUG
         config_verify: True
+        dnac_api_task_timeout: 1000
+        dnac_task_poll_interval: 1
         config:
         - import_image_details:
             type: "{{ item.type }}"
             url_details:
               payload:
-              - source_url: http://10.197.156.28/stda/abimishr/cat9k_iosxe.17.12.01.SPA.bin
+              - source_url: http://172.21.236.183/swim/V1712_2_CCO/cat9k_iosxe.17.12.02.SPA.bin
                 third_party: False
           tagging_details:
-            image_name: "{{item.image_name}}"
+            image_name: cat9k_iosxe.17.12.02.SPA.bin
+            device_role: ALL
+            device_image_family_name: Cisco Catalyst 9300 Switch
             site_name: "{{item.site_name}}"
-            device_role: "{{ item.device_role }}"
-            device_image_family_name: "{{ item.device_image_family_name }}"
-            tagging: False
-          image_distribution_details:
-            image_name: "{{item.image_name}}"
-            site_name: "{{item.site_name}}"
-            device_role: "{{ item.device_role }}"
-            device_family_name: "{{ item.device_family_name }}"
-            device_series_name: "Catalyst 9300 Series"
+            tagging: True
+          # image_distribution_details:
+          #   image_name: cat9k_iosxe.17.12.02.SPA.bin
+          #   site_name: "{{item.site_name}}"
+          #   device_role: "{{ item.device_role }}"
+          #   device_family_name: "{{ item.device_family_name }}"
+          #   device_series_name: "Catalyst 9300 Series"
           image_activation_details:
-            image_name: "{{item.image_name}}"
+            image_name: cat9k_iosxe.17.12.02.SPA.bin
             site_name: "{{item.site_name}}"
             device_role: "{{ item.device_role }}"
             device_family_name: "{{ item.device_family_name }}"
@@ -49,4 +51,4 @@
 
       with_items: "{{ image_details }}"
       tags:
-        - swim  
+        - swim  
diff --git a/plugins/doc_fragments/intent_params.py b/plugins/doc_fragments/intent_params.py
@@ -95,6 +95,15 @@ class ModuleDocFragment(object):
         description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
         type: bool
         default: True
+    dnac_api_task_timeout:
+      description:  Defines the timeout in seconds for API calls to retrieve task details. If the task details
+          are not received within this period, the process will end, and a timeout notification will be logged.
+      type: int
+      default: 1200
+    dnac_task_poll_interval:
+      description: Specifies the interval in seconds between successive calls to the API to retrieve task details.
+      type: int
+      default: 2
     validate_response_schema:
         description:
           - Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

diff --git a/plugins/doc_fragments/workflow_manager_params.py b/plugins/doc_fragments/workflow_manager_params.py
@@ -101,6 +101,15 @@ class ModuleDocFragment(object):
           - Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.
         type: bool
         default: true
+    dnac_api_task_timeout:
+      description:  Defines the timeout in seconds for API calls to retrieve task details. If the task details
+          are not received within this period, the process will end, and a timeout notification will be logged.
+      type: int
+      default: 1200
+    dnac_task_poll_interval:
+      description: Specifies the interval in seconds between successive calls to the API to retrieve task details.
+      type: int
+      default: 2
 notes:
     - "Does not support C(check_mode)"
     - "The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK"

diff --git a/plugins/modules/device_credential_intent.py b/plugins/modules/device_credential_intent.py
@@ -2583,6 +2583,8 @@ def main():
         "dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
         "dnac_log_append": {"type": 'bool', "default": True},
         "config_verify": {"type": 'bool', "default": False},
+        'dnac_api_task_timeout': {'type': 'int', "default": 1200},
+        'dnac_task_poll_interval': {'type': 'int', "default": 2},
         "config": {"type": 'list', "required": True, "elements": 'dict'},
         "state": {"default": 'merged', "choices": ['merged', 'deleted']},
         "validate_response_schema": {"type": 'bool', "default": True},

diff --git a/plugins/modules/device_credential_workflow_manager.py b/plugins/modules/device_credential_workflow_manager.py
@@ -2582,6 +2582,8 @@ def main():
         "dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
         "dnac_log_append": {"type": 'bool', "default": True},
         "config_verify": {"type": 'bool', "default": False},
+        'dnac_api_task_timeout': {'type': 'int', "default": 1200},
+        'dnac_task_poll_interval': {'type': 'int', "default": 2},
         "config": {"type": 'list', "required": True, "elements": 'dict'},
         "state": {"default": 'merged', "choices": ['merged', 'deleted']},
         "validate_response_schema": {"type": 'bool', "default": True},