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

Develop

Author: bvargasre

.github/workflows/sanity_tests.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
-          python-version: '3.11'
+          python-version: '3.12'
 
       - name: Install ansible-base (${{ matrix.ansible }})
         run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check

Dockerfile.ansible-test

@@ -1,8 +1,8 @@
 FROM quay.io/centos/centos:stream9
 
-RUN dnf install -y python3.11 python3.11-pip git gcc python3.11-devel && \
-    alternatives --install /usr/bin/python python /usr/bin/python3.11 1 && \
-    pip3.11 install --upgrade pip
+RUN dnf install -y python3.12 python3.12-pip git gcc python3.12-devel && \
+    alternatives --install /usr/bin/python python /usr/bin/python3.12 1 && \
+    pip3.12 install --upgrade pip
 
 RUN pip install git+https://github.com/ansible/ansible@devel
 

README.md

@@ -16,7 +16,7 @@ The following table shows the supported versions.
 |-------------------------------|----------------------------------------|------------------------------------|
 | 2.3.7.6                       | 1.0.0                                  |  2.3.7.6.2                         |
 | 2.3.7.9                       | 2.1.4                                  |  2.3.7.9.5                         |
-| 3.1.3.0                       | ^2.2.0                                 |  ^3.1.3.0.0                        |
+| 3.1.3.0                       | ^2.2.1                                 |  ^3.1.3.0.0                        |
 
 If your Ansible collection is older please consider updating it first.
 
@@ -107,13 +107,13 @@ ansible-playbook -i hosts myplaybook.yml
 First, define a `credentials.yml` ([example](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/playbooks/credentials.template)) file where you specify your CATALYST Center credentials as Ansible variables:
 ```
 ---
-_host: <A.B.C.D>
-_api_port: 443  # optional, defaults to 443
-_username: <username>
-_password: <password>
-_version: 2.3.7.6  # optional, defaults to 2.3.7.6. See the Compatibility matrix
-_verify: False  # optional, defaults to True
-_debug: False  # optional, defaults to False
+host: <A.B.C.D>
+api_port: 443  # optional, defaults to 443
+username: <username>
+password: <password>
+version: 2.3.7.6  # optional, defaults to 2.3.7.6. See the Compatibility matrix
+verify: False  # optional, defaults to True
+debug: False  # optional, defaults to False
 ```
 
 Create a `hosts` ([example](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/playbooks/hosts)) file that uses `[catalystcenter_servers]` with your Cisco CATALYST Center Settings:
@@ -131,10 +131,10 @@ Then, create a playbook `myplaybook.yml` ([example](https://github.com/cisco-en-
   tasks:
   - name: Create tag with name "MyNewTag"
     cisco.catalystcenter.tag:
-      _host: "{{_host}}"
-      _username: "{{ _username }}"
-      _password: "{{ _password }}"
-      _verify: "{{ _verify }}"
+      host: "{{ host }}"
+      username: "{{ username }}"
+      password: "{{ password }}"
+      verify: "{{ verify }}"
       state: present
       description: My Tag
       name: MyNewTag

changelogs/changelog.yaml

@@ -67,3 +67,15 @@ releases:
       release_summary: Update Modules
       minor_changes:
         - Collection is now compatible with Catalyst Center API 3.1.3.0.
+  2.2.1:
+    release_date: "2025-08-07"
+    changes:
+      release_summary: Complete migration to catc_ prefixed parameters
+      minor_changes:
+        - Migrated all connection and logging parameters to use catc_ prefix (catc_host, catc_username, catc_password, catc_verify, catc_api_port, catc_version, catc_debug, catc_log, catc_log_level, catc_log_append, catc_log_file_path)
+        - Updated all module examples, playbooks, and documentation to use new parameter names
+        - Updated credentials files and doc fragments with new parameter structure
+        - Added timeout parameters catc_api_task_timeout and catc_task_poll_interval to core argument specifications
+        - Maintained backward compatibility through comprehensive aliases for legacy parameter names
+        - Standardized parameter naming across all workflow manager modules
+        - Fixed element_spec definitions in all modules to use consistent catc_ prefixed parameters

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: catalystcenter
-version: 2.2.0
+version: 2.2.1
 readme: README.md
 authors:
   - Rafael Campos <[email protected]>

playbooks/PnP.yml

@@ -7,19 +7,19 @@
     - "{{ CLUSTERFILE }}"
   vars:
     catalystcenter_login: &catalystcenter_login
-      _host: "{{ _host }}"
-      _username: "{{ _username }}"
-      _password: "{{ _password }}"
-      _verify: "{{ _verify }}"
-      _api_port: "{{ _api_port }}"
-      _version: "{{ _version }}"
-      _debug: "{{ _debug }}"
-      log_level: DEBUG
+      catc_host: "{{ catc_host }}"
+      catc_username: "{{ catc_username }}"
+      catc_password: "{{ catc_password }}"
+      catc_verify: "{{ catc_verify }}"
+      catc_api_port: "{{ catc_api_port }}"
+      catc_version: "{{ catc_version }}"
+      catc_debug: "{{ catc_debug }}"
+      catc_log_level: DEBUG
   tasks:
     - name: Import devices in bulk
       cisco.catalystcenter.pnp_intent:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config_verify: true
         config:
@@ -38,7 +38,7 @@
     - name: Add a new device and claim it
       cisco.catalystcenter.pnp_intent:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config:
           - site_name: Global/USA/San Francisco/BGL_18
@@ -51,7 +51,7 @@
     - name: Claim a pre-added switch, apply a template, and perform an image upgrade for a specific site
       cisco.catalystcenter.pnp_intent:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config:
           - site_name: Global/USA/San Francisco/BGL_18
@@ -69,7 +69,7 @@
     - name: Claim an existing Wireless Controller, apply a template, and upgrade its image for a specified site
       cisco.catalystcenter.pnp_intent:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config:
           - site_name: Global/USA/San Francisco/BGL_18
@@ -91,7 +91,7 @@
     - name: Remove multiple devices from the PnP dashboard safely (ignores non-existent devices)
       cisco.catalystcenter.pnp_intent:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: deleted
         config_verify: true
         config:

playbooks/PnP_Workflow_Manager_Playbook.yml

@@ -7,19 +7,19 @@
     - "{{ CLUSTERFILE }}"
   vars:
     catalystcenter_login: &catalystcenter_login
-      _host: "{{ _host }}"
-      _username: "{{ _username }}"
-      _password: "{{ _password }}"
-      _verify: "{{ _verify }}"
-      _api_port: "{{ _api_port }}"
-      _version: "{{ _version }}"
-      _debug: "{{ _debug }}"
-      log_level: DEBUG
+      catc_host: "{{ catc_host }}"
+      catc_username: "{{ catc_username }}"
+      catc_password: "{{ catc_password }}"
+      catc_verify: "{{ catc_verify }}"
+      catc_api_port: "{{ catc_api_port }}"
+      catc_version: "{{ catc_version }}"
+      catc_debug: "{{ catc_debug }}"
+      catc_log_level: DEBUG
   tasks:
     - name: Import devices in bulk
       cisco.catalystcenter.pnp_workflow_manager:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config_verify: true
         config:
@@ -38,7 +38,7 @@
     - name: Add a new device and claim it
       cisco.catalystcenter.pnp_workflow_manager:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config:
           - site_name: Global/USA/San Francisco/BGL_18
@@ -51,7 +51,7 @@
     - name: Claim a pre-added switch, apply a template, and perform an image upgrade for a specific site
       cisco.catalystcenter.pnp_workflow_manager:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config:
           - site_name: Global/USA/San Francisco/BGL_18
@@ -69,7 +69,7 @@
     - name: Claim an existing Wireless Controller, apply a template, and upgrade its image for a specified site
       cisco.catalystcenter.pnp_workflow_manager:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: merged
         config:
           - site_name: Global/USA/San Francisco/BGL_18
@@ -91,7 +91,7 @@
     - name: Remove multiple devices from the PnP dashboard safely (ignores non-existent devices)
       cisco.catalystcenter.pnp_workflow_manager:
         !!merge <<: *catalystcenter_login
-        log: true
+        catc_log: true
         state: deleted
         config_verify: true
         config:

playbooks/accesspoint_workflow_manager.yml

@@ -8,15 +8,15 @@
   tasks:
     - name: Updating Access Point Site / Configuration details
       cisco.catalystcenter.accesspoint_workflow_manager:
-        _host: "{{ _host }}"
-        _username: "{{ _username }}"
-        _password: "{{ _password }}"
-        _verify: "{{ _verify }}"
-        _api_port: "{{ _api_port }}"
-        _version: "{{ _version }}"
-        _debug: "{{ _debug }}"
-        log: true
-        log_level: DEBUG
+        catc_host: "{{ catc_host }}"
+        catc_username: "{{ catc_username }}"
+        catc_password: "{{ catc_password }}"
+        catc_verify: "{{ catc_verify }}"
+        catc_api_port: "{{ catc_api_port }}"
+        catc_version: "{{ catc_version }}"
+        catc_debug: "{{ catc_debug }}"
+        catc_log: true
+        catc_log_level: DEBUG
         config_verify: true
         state: merged
         force_sync: false

playbooks/app_policy_queuing_profile.yml

@@ -7,13 +7,13 @@
   tasks:
     - name: Create
       cisco.catalystcenter.app_policy_queuing_profile:
-        _host: "{{ _host }}"
-        _username: "{{ _username }}"
-        _password: "{{ _password }}"
-        _verify: "{{ _verify }}"
-        _api_port: "{{ _api_port }}"
-        _version: "{{ _version }}"
-        _debug: "{{ _debug }}"
+        catc_host: "{{ catc_host }}"
+        catc_username: "{{ catc_username }}"
+        catc_password: "{{ catc_password }}"
+        catc_verify: "{{ catc_verify }}"
+        catc_api_port: "{{ catc_api_port }}"
+        catc_version: "{{ catc_version }}"
+        catc_debug: "{{ catc_debug }}"
         state: present
         id: "a"
         payload:

playbooks/application_set_info.yml

@@ -7,10 +7,10 @@
   tasks:
     - name: Get application sets local-services
       cisco.catalystcenter.application_sets_info:
-        _host: "{{ _host }}"
-        _username: "{{ _username }}"
-        _password: "{{ _password }}"
-        _verify: "{{ _verify }}"
+        catc_host: "{{ catc_host }}"
+        catc_username: "{{ catc_username }}"
+        catc_password: "{{ catc_password }}"
+        catc_verify: "{{ catc_verify }}"
         name: local-services
         # limit: 3
         # offset: 2