Merge pull request #22 from cisco-en-programmability/roles-fix

docs(roles): update all 69 role READMEs and add roles/README.md catalog

Author: DNACENSolutions

roles/README.md

@@ -5,8 +5,9 @@ This role manages Access Point configurations in Cisco Catalyst Center using the
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
+- Cisco Catalyst Center >= 2.3.5.3
 
 ## Role Variables
 
@@ -16,10 +17,15 @@ This role manages Access Point configurations in Cisco Catalyst Center using the
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `accesspoint_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -34,7 +40,7 @@ None
 ## Example Playbook
 
 ```yaml
-- hosts: catalystcenter
+- hosts: localhost
   roles:
     - role: accesspoint
       vars:

roles/accesspoint/README.md

@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'accesspoint_workflow_manager' module.
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
 
 ## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'accesspoint_workflow_manager' module.
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `accesspoint_config_generator_state` the desired state of Cisco Catalyst Center after module execution. Choices: `gathered`. Default: `gathered`.

roles/accesspoint_config_generator/README.md

@@ -9,7 +9,7 @@ Resource module for managing Access Point planned positions and real positions i
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
 
 ## Role Variables
@@ -20,10 +20,15 @@ Resource module for managing Access Point planned positions and real positions i
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `accesspoint_location_config_verify` set to `True` to enable configuration verification on Cisco Catalyst Center after applying the playbook configuration. This ensures that the system validates the configuration state after the changes are applied. Default: `false`.

roles/accesspoint_location/README.md

@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'accesspoint_location_workflow_manager
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
 
 ## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'accesspoint_location_workflow_manager
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `accesspoint_location_config_generator_state` the desired state of Cisco Catalyst Center after module execution. Choices: `gathered`. Default: `gathered`.

roles/accesspoint_location_config_generator/README.md

@@ -5,7 +5,7 @@ This role manages Application Policy configurations in Cisco Catalyst Center usi
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
 
 ## Role Variables
@@ -16,10 +16,15 @@ This role manages Application Policy configurations in Cisco Catalyst Center usi
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `application_policy_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -33,15 +38,15 @@ None
 ## Example Playbook
 
 ```yaml
-- hosts: catalystcenter
+- hosts: localhost
   roles:
     - role: application_policy
       vars:
         catalystcenter_host: "{{ vault_catalystcenter_host }}"
         catalystcenter_username: "{{ vault_catalystcenter_username }}"
         catalystcenter_password: "{{ vault_catalystcenter_password }}"
         application_policy_config:
-          - policy_name: "App-Policy-01"
+          - application_policy: {}
 ```
 
 <!-- BEGIN WORKFLOW README ENHANCEMENTS -->

roles/application_policy/README.md

@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'application_policy_workflow_manager'
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
 
 ## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'application_policy_workflow_manager'
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `application_policy_config_generator_state` the desired state of Cisco Catalyst Center after module execution. Choices: `gathered`. Default: `gathered`.

roles/application_policy_config_generator/README.md

@@ -5,8 +5,9 @@ This role manages Assurance Device Health Score Settings in Cisco Catalyst Cente
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
+- Cisco Catalyst Center >= 2.3.7.9
 
 ## Role Variables
 
@@ -16,10 +17,15 @@ This role manages Assurance Device Health Score Settings in Cisco Catalyst Cente
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `assurance_device_health_score_settings_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -33,15 +39,15 @@ None
 ## Example Playbook
 
 ```yaml
-- hosts: catalystcenter
+- hosts: localhost
   roles:
     - role: assurance_device_health_score_settings
       vars:
         catalystcenter_host: "{{ vault_catalystcenter_host }}"
         catalystcenter_username: "{{ vault_catalystcenter_username }}"
         catalystcenter_password: "{{ vault_catalystcenter_password }}"
         assurance_device_health_score_settings_config:
-          - setting_name: "health-score-01"
+          - device_health_score: {}
 ```
 
 <!-- BEGIN WORKFLOW README ENHANCEMENTS -->

roles/assurance_device_health_score_settings/README.md

@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'assurance_device_health_score_setting
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
 
 ## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'assurance_device_health_score_setting
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `assurance_device_health_score_settings_config_generator_state` the desired state of Cisco Catalyst Center after module completion. Only C(gathered) state is supported for brownfield configuration extraction. In C(gathered) state, the module extracts existing device health score settings from Catalyst Center and generates a YAML playbook file. Choices: `gathered`. Default: `gathered`.
@@ -47,7 +52,7 @@ None
         catalystcenter_password: "{{ vault_catalystcenter_password }}"
         assurance_device_health_score_settings_config_generator_file_path: "tmp/assurance_device_health_score_settings_config_generator.yml"
         assurance_device_health_score_settings_config_generator_config:
-          global_filters: {}
+          component_specific_filters: {}
 ```
 
 <!-- BEGIN WORKFLOW README ENHANCEMENTS -->

roles/assurance_device_health_score_settings_config_generator/README.md

@@ -5,8 +5,9 @@ This role manages Assurance ICAP Settings in Cisco Catalyst Center using the `as
 ## Requirements
 
 - `cisco.catalystcenter` collection installed
-- Catalyst Center SDK >= 3.1.3.0.0
+- catalystcentersdk >= 3.1.6.0.2
 - Python >= 3.9
+- Cisco Catalyst Center >= 2.3.7.9
 
 ## Role Variables
 
@@ -16,10 +17,15 @@ This role manages Assurance ICAP Settings in Cisco Catalyst Center using the `as
 - `catalystcenter_password`: Password for authentication (required)
 - `catalystcenter_verify`: SSL certificate verification (default: `false`)
 - `catalystcenter_port`: API port (default: `443`)
-- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
+- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
 - `catalystcenter_debug`: Enable debug mode (default: `false`)
 - `catalystcenter_log_level`: Logging level (default: `INFO`)
 - `catalystcenter_log`: Enable logging (default: `false`)
+- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
+- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
+- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
+- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
+- `validate_response_schema`: Validate API response schema (default: `true`)
 
 ### Role-Specific Variables
 - `assurance_icap_settings_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -33,15 +39,15 @@ None
 ## Example Playbook
 
 ```yaml
-- hosts: catalystcenter
+- hosts: localhost
   roles:
     - role: assurance_icap_settings
       vars:
         catalystcenter_host: "{{ vault_catalystcenter_host }}"
         catalystcenter_username: "{{ vault_catalystcenter_username }}"
         catalystcenter_password: "{{ vault_catalystcenter_password }}"
         assurance_icap_settings_config:
-          - icap_server: "icap-server-01"
+          - assurance_icap_settings: {}
 ```
 
 <!-- BEGIN WORKFLOW README ENHANCEMENTS -->