Skip to content

Commit 42b02ad

Browse files
author
minhtle
committed
docs(roles): update all 69 role READMEs and add roles/README.md catalog
1 parent 0d33dc2 commit 42b02ad

70 files changed

Lines changed: 944 additions & 225 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

roles/README.md

Lines changed: 344 additions & 0 deletions
Large diffs are not rendered by default.

roles/accesspoint/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ This role manages Access Point configurations in Cisco Catalyst Center using the
55
## Requirements
66

77
- `cisco.catalystcenter` collection installed
8-
- Catalyst Center SDK >= 3.1.3.0.0
8+
- catalystcentersdk >= 3.1.6.0.2
99
- Python >= 3.9
10+
- Cisco Catalyst Center >= 2.3.5.3
1011

1112
## Role Variables
1213

@@ -16,10 +17,15 @@ This role manages Access Point configurations in Cisco Catalyst Center using the
1617
- `catalystcenter_password`: Password for authentication (required)
1718
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
1819
- `catalystcenter_port`: API port (default: `443`)
19-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
20+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2021
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2122
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2223
- `catalystcenter_log`: Enable logging (default: `false`)
24+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
25+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
26+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
27+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
28+
- `validate_response_schema`: Validate API response schema (default: `true`)
2329

2430
### Role-Specific Variables
2531
- `accesspoint_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -34,7 +40,7 @@ None
3440
## Example Playbook
3541

3642
```yaml
37-
- hosts: catalystcenter
43+
- hosts: localhost
3844
roles:
3945
- role: accesspoint
4046
vars:

roles/accesspoint_config_generator/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'accesspoint_workflow_manager' module.
99
## Requirements
1010

1111
- `cisco.catalystcenter` collection installed
12-
- Catalyst Center SDK >= 3.1.3.0.0
12+
- catalystcentersdk >= 3.1.6.0.2
1313
- Python >= 3.9
1414

1515
## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'accesspoint_workflow_manager' module.
2020
- `catalystcenter_password`: Password for authentication (required)
2121
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
2222
- `catalystcenter_port`: API port (default: `443`)
23-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
23+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2424
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2525
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2626
- `catalystcenter_log`: Enable logging (default: `false`)
27+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
28+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
29+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
30+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
31+
- `validate_response_schema`: Validate API response schema (default: `true`)
2732

2833
### Role-Specific Variables
2934
- `accesspoint_config_generator_state` the desired state of Cisco Catalyst Center after module execution. Choices: `gathered`. Default: `gathered`.

roles/accesspoint_location/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Resource module for managing Access Point planned positions and real positions i
99
## Requirements
1010

1111
- `cisco.catalystcenter` collection installed
12-
- Catalyst Center SDK >= 3.1.3.0.0
12+
- catalystcentersdk >= 3.1.6.0.2
1313
- Python >= 3.9
1414

1515
## Role Variables
@@ -20,10 +20,15 @@ Resource module for managing Access Point planned positions and real positions i
2020
- `catalystcenter_password`: Password for authentication (required)
2121
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
2222
- `catalystcenter_port`: API port (default: `443`)
23-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
23+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2424
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2525
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2626
- `catalystcenter_log`: Enable logging (default: `false`)
27+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
28+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
29+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
30+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
31+
- `validate_response_schema`: Validate API response schema (default: `true`)
2732

2833
### Role-Specific Variables
2934
- `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_config_generator/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'accesspoint_location_workflow_manager
99
## Requirements
1010

1111
- `cisco.catalystcenter` collection installed
12-
- Catalyst Center SDK >= 3.1.3.0.0
12+
- catalystcentersdk >= 3.1.6.0.2
1313
- Python >= 3.9
1414

1515
## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'accesspoint_location_workflow_manager
2020
- `catalystcenter_password`: Password for authentication (required)
2121
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
2222
- `catalystcenter_port`: API port (default: `443`)
23-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
23+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2424
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2525
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2626
- `catalystcenter_log`: Enable logging (default: `false`)
27+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
28+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
29+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
30+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
31+
- `validate_response_schema`: Validate API response schema (default: `true`)
2732

2833
### Role-Specific Variables
2934
- `accesspoint_location_config_generator_state` the desired state of Cisco Catalyst Center after module execution. Choices: `gathered`. Default: `gathered`.

roles/application_policy/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This role manages Application Policy configurations in Cisco Catalyst Center usi
55
## Requirements
66

77
- `cisco.catalystcenter` collection installed
8-
- Catalyst Center SDK >= 3.1.3.0.0
8+
- catalystcentersdk >= 3.1.6.0.2
99
- Python >= 3.9
1010

1111
## Role Variables
@@ -16,10 +16,15 @@ This role manages Application Policy configurations in Cisco Catalyst Center usi
1616
- `catalystcenter_password`: Password for authentication (required)
1717
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
1818
- `catalystcenter_port`: API port (default: `443`)
19-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
19+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2020
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2121
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2222
- `catalystcenter_log`: Enable logging (default: `false`)
23+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
24+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
25+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
26+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
27+
- `validate_response_schema`: Validate API response schema (default: `true`)
2328

2429
### Role-Specific Variables
2530
- `application_policy_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -33,15 +38,15 @@ None
3338
## Example Playbook
3439

3540
```yaml
36-
- hosts: catalystcenter
41+
- hosts: localhost
3742
roles:
3843
- role: application_policy
3944
vars:
4045
catalystcenter_host: "{{ vault_catalystcenter_host }}"
4146
catalystcenter_username: "{{ vault_catalystcenter_username }}"
4247
catalystcenter_password: "{{ vault_catalystcenter_password }}"
4348
application_policy_config:
44-
- policy_name: "App-Policy-01"
49+
- application_policy: {}
4550
```
4651
4752
<!-- BEGIN WORKFLOW README ENHANCEMENTS -->

roles/application_policy_config_generator/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'application_policy_workflow_manager'
99
## Requirements
1010

1111
- `cisco.catalystcenter` collection installed
12-
- Catalyst Center SDK >= 3.1.3.0.0
12+
- catalystcentersdk >= 3.1.6.0.2
1313
- Python >= 3.9
1414

1515
## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'application_policy_workflow_manager'
2020
- `catalystcenter_password`: Password for authentication (required)
2121
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
2222
- `catalystcenter_port`: API port (default: `443`)
23-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
23+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2424
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2525
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2626
- `catalystcenter_log`: Enable logging (default: `false`)
27+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
28+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
29+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
30+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
31+
- `validate_response_schema`: Validate API response schema (default: `true`)
2732

2833
### Role-Specific Variables
2934
- `application_policy_config_generator_state` the desired state of Cisco Catalyst Center after module execution. Choices: `gathered`. Default: `gathered`.

roles/assurance_device_health_score_settings/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ This role manages Assurance Device Health Score Settings in Cisco Catalyst Cente
55
## Requirements
66

77
- `cisco.catalystcenter` collection installed
8-
- Catalyst Center SDK >= 3.1.3.0.0
8+
- catalystcentersdk >= 3.1.6.0.2
99
- Python >= 3.9
10+
- Cisco Catalyst Center >= 2.3.7.9
1011

1112
## Role Variables
1213

@@ -16,10 +17,15 @@ This role manages Assurance Device Health Score Settings in Cisco Catalyst Cente
1617
- `catalystcenter_password`: Password for authentication (required)
1718
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
1819
- `catalystcenter_port`: API port (default: `443`)
19-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
20+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2021
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2122
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2223
- `catalystcenter_log`: Enable logging (default: `false`)
24+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
25+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
26+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
27+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
28+
- `validate_response_schema`: Validate API response schema (default: `true`)
2329

2430
### Role-Specific Variables
2531
- `assurance_device_health_score_settings_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -33,15 +39,15 @@ None
3339
## Example Playbook
3440

3541
```yaml
36-
- hosts: catalystcenter
42+
- hosts: localhost
3743
roles:
3844
- role: assurance_device_health_score_settings
3945
vars:
4046
catalystcenter_host: "{{ vault_catalystcenter_host }}"
4147
catalystcenter_username: "{{ vault_catalystcenter_username }}"
4248
catalystcenter_password: "{{ vault_catalystcenter_password }}"
4349
assurance_device_health_score_settings_config:
44-
- setting_name: "health-score-01"
50+
- device_health_score: {}
4551
```
4652
4753
<!-- BEGIN WORKFLOW README ENHANCEMENTS -->

roles/assurance_device_health_score_settings_config_generator/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Generate YAML configurations playbook for 'assurance_device_health_score_setting
99
## Requirements
1010

1111
- `cisco.catalystcenter` collection installed
12-
- Catalyst Center SDK >= 3.1.3.0.0
12+
- catalystcentersdk >= 3.1.6.0.2
1313
- Python >= 3.9
1414

1515
## Role Variables
@@ -20,10 +20,15 @@ Generate YAML configurations playbook for 'assurance_device_health_score_setting
2020
- `catalystcenter_password`: Password for authentication (required)
2121
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
2222
- `catalystcenter_port`: API port (default: `443`)
23-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
23+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2424
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2525
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2626
- `catalystcenter_log`: Enable logging (default: `false`)
27+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
28+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
29+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
30+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
31+
- `validate_response_schema`: Validate API response schema (default: `true`)
2732

2833
### Role-Specific Variables
2934
- `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
4752
catalystcenter_password: "{{ vault_catalystcenter_password }}"
4853
assurance_device_health_score_settings_config_generator_file_path: "tmp/assurance_device_health_score_settings_config_generator.yml"
4954
assurance_device_health_score_settings_config_generator_config:
50-
global_filters: {}
55+
component_specific_filters: {}
5156
```
5257
5358
<!-- BEGIN WORKFLOW README ENHANCEMENTS -->

roles/assurance_icap_settings/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ This role manages Assurance ICAP Settings in Cisco Catalyst Center using the `as
55
## Requirements
66

77
- `cisco.catalystcenter` collection installed
8-
- Catalyst Center SDK >= 3.1.3.0.0
8+
- catalystcentersdk >= 3.1.6.0.2
99
- Python >= 3.9
10+
- Cisco Catalyst Center >= 2.3.7.9
1011

1112
## Role Variables
1213

@@ -16,10 +17,15 @@ This role manages Assurance ICAP Settings in Cisco Catalyst Center using the `as
1617
- `catalystcenter_password`: Password for authentication (required)
1718
- `catalystcenter_verify`: SSL certificate verification (default: `false`)
1819
- `catalystcenter_port`: API port (default: `443`)
19-
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.6`)
20+
- `catalystcenter_version`: Catalyst Center version (default: `2.3.7.9`)
2021
- `catalystcenter_debug`: Enable debug mode (default: `false`)
2122
- `catalystcenter_log_level`: Logging level (default: `INFO`)
2223
- `catalystcenter_log`: Enable logging (default: `false`)
24+
- `catalystcenter_log_file_path`: Log file path (default: `catalystcenter.log`)
25+
- `catalystcenter_log_append`: Append to log file instead of overwriting (default: `true`)
26+
- `catalystcenter_api_task_timeout`: Timeout in seconds for API task polling (default: `1200`)
27+
- `catalystcenter_task_poll_interval`: Interval in seconds between task status polls (default: `2`)
28+
- `validate_response_schema`: Validate API response schema (default: `true`)
2329

2430
### Role-Specific Variables
2531
- `assurance_icap_settings_state`: Desired state - `merged` or `deleted` (default: `merged`)
@@ -33,15 +39,15 @@ None
3339
## Example Playbook
3440

3541
```yaml
36-
- hosts: catalystcenter
42+
- hosts: localhost
3743
roles:
3844
- role: assurance_icap_settings
3945
vars:
4046
catalystcenter_host: "{{ vault_catalystcenter_host }}"
4147
catalystcenter_username: "{{ vault_catalystcenter_username }}"
4248
catalystcenter_password: "{{ vault_catalystcenter_password }}"
4349
assurance_icap_settings_config:
44-
- icap_server: "icap-server-01"
50+
- assurance_icap_settings: {}
4551
```
4652
4753
<!-- BEGIN WORKFLOW README ENHANCEMENTS -->

0 commit comments

Comments
 (0)