Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 84 additions & 81 deletions CVP_GUIDE.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Roles reduce boilerplate by providing sensible defaults for connection parameter

**Config Generator Roles**: Add `_config_generator` suffix to any of the following: `accesspoint`, `accesspoint_location`, `application_policy`, `assurance_device_health_score_settings`, `assurance_issue`, `backup_and_restore`, `device_credential`, `discovery`, `events_and_notifications`, `inventory`, `ise_radius_integration`, `network_profile_switching`, `network_profile_wireless`, `network_settings`, `pnp`, `provision`, `rma`, `sda_extranet_policies`, `sda_fabric_devices`, `sda_fabric_multicast`, `sda_fabric_sites_zones`, `sda_fabric_transits`, `sda_fabric_virtual_networks`, `sda_host_port_onboarding`, `site`, `tags`, `template`, `user_role`, `wired_campus_automation`, `wireless_design`

For detailed role documentation, examples, and best practices, see [ROLES_GUIDE.md](ROLES_GUIDE.md) and the [example roles playbook](playbooks/example_roles_playbook.yml).
For detailed role documentation, examples, and best practices, see [ROLES_GUIDE.md](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/ROLES_GUIDE.md) and the [example roles playbook](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/playbooks/example_roles_playbook.yml).


## CVP - Cisco Validated Playbooks
Expand Down Expand Up @@ -245,7 +245,7 @@ ansible-playbook playbook/site_hierarchy_playbook.yml
| **Playbooks** | Quick examples | `playbooks/tag.yml` |
| **CVP** | Production deployments | `cvp/site_hierarchy/` ⭐ |

For complete CVP documentation, catalog, and usage examples, see [CVP_GUIDE.md](CVP_GUIDE.md) and [cvp/README.md](cvp/README.md).
For complete CVP documentation, catalog, and usage examples, see [CVP_GUIDE.md](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/CVP_GUIDE.md) and [cvp/README.md](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/cvp/README.md).


## Use Cases
Expand Down Expand Up @@ -288,7 +288,7 @@ Please read and familiarize yourself with this document.

This collection is available on both Ansible Galaxy and Red Hat Automation Hub.

For certified content obtained from Red Hat Automation Hub, support is provided through Red Hat Ansible Automation Platform according to your subscription agreement.
For certified content obtained from Red Hat Automation Hub, open support requests from the collection page using `Create issue`: [Cisco Catalyst Center on Red Hat Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/cisco/catalystcenter/). Support is provided through Red Hat Ansible Automation Platform according to your subscription agreement.

For content obtained from Ansible Galaxy, community support may be available via:
- [Ansible Forum](https://forum.ansible.com/)
Expand Down Expand Up @@ -319,7 +319,7 @@ This collection follows [Semantic Versioning](https://semver.org/). For roadmap

## License

This collection is licensed under the Cisco Sample Code License.
This collection is licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later).

The full license text is available in the [LICENSE](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/LICENSE) file.

Expand Down
9 changes: 6 additions & 3 deletions cvp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,8 @@ yamale -s schema/sites_schema.yml vars/site_hierarchy_design_vars.yml

## 🚀 CI/CD Integration

For Red Hat certified deployments, use an Ansible Execution Environment or runner image that already includes `ansible-core >= 2.16` with Python `3.12`. The example below installs only the Cisco Catalyst Center Python SDK.

### GitHub Actions

```yaml
Expand All @@ -419,9 +421,9 @@ jobs:
steps:
- uses: actions/checkout@v3

- name: Install Ansible
- name: Install Collection Dependencies
run: |
pip install ansible catalystcentersdk
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter

- name: Copy CVP
Expand All @@ -446,8 +448,9 @@ For issues or questions about CVPs:

1. **Check CVP README** - Each CVP has detailed documentation
2. **Review Examples** - Look at the vars/ directory for examples
3. **Open an Issue** - [GitHub Issues](https://github.com/cisco-en-programmability/catalystcenter-ansible/issues)
3. **Certified Support** - Use `Create issue` from the [Cisco Catalyst Center collection page on Red Hat Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/cisco/catalystcenter/)
4. **Consult Documentation** - [Collection Documentation](https://cisco-en-programmability.github.io/catalystcenter-ansible/)
5. **Community Issues** - [GitHub Issues](https://github.com/cisco-en-programmability/catalystcenter-ansible/issues)

---

Expand Down
20 changes: 10 additions & 10 deletions cvp/access_point_location/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down Expand Up @@ -248,7 +248,7 @@ accesspoint_location_details:
elevation: 30

```
![alt text](./images/image1.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image1.png)

##### 2. **Update Planned Access Point Position**
*Example*: Modify existing planned AP position and radio settings.
Expand Down Expand Up @@ -289,7 +289,7 @@ accesspoint_location_details:
elevation: 30

```
![alt text](./images/image2.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image2.png)

##### 3. **Create Planned Position with Dual-Band Radio**
*Example*: Configure an AP with a single dual-band radio.
Expand All @@ -315,7 +315,7 @@ accesspoint_location_details:
elevation: 20
```

![alt text](./images/image3.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image3.png)

##### 3. **Assign Planned Access Point to Real Access Point**
*Example*: Map a planned position to an actual physical AP.
Expand All @@ -331,7 +331,7 @@ accesspoint_location_details:
action: "assign_planned_ap"
mac_address: "68:7d:b4:06:b0:a0"
```
![alt text](./images/image4.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image4.png)

##### 4. **Create Real AP Position**
*Example*: Create a real AP position directly (without planned position).
Expand Down Expand Up @@ -365,7 +365,7 @@ accesspoint_location_details:
elevation: 30
```

![alt text](./images/image5.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image5.png)

##### 6. **Update Real AP Position (Partial Update)**
*Example*: Update only position and antenna settings for a real AP.
Expand Down Expand Up @@ -400,7 +400,7 @@ accesspoint_location_details:
azimuth: 20
elevation: 30
```
![alt text](./images/image6.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image6.png)


##### 7. **Create Access Point with 6GHz Radio**
Expand All @@ -426,7 +426,7 @@ accesspoint_location_details:
azimuth: 90
elevation: 0
```
![alt text](./images/image7.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image7.png)


**Validate**
Expand Down Expand Up @@ -608,7 +608,7 @@ accesspoint_location_details:
access_points:
- accesspoint_name: "AP687D.B402.1614-AP-location_Test2"
```
![alt text](./images/image9.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image9.png)

##### 2. **Delete real AP position from Planned Position**
*Example*: Remove real AP from its assigned planned position.
Expand All @@ -623,7 +623,7 @@ accesspoint_location_details:
- accesspoint_name: "AP687D.B402.1614-AP-Test6"
action: "manage_real_ap"
```
![alt text](./images/image8.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/access_point_location/images/image8.png)
---
## Example Output
1.Delete Planned AP positions
Expand Down
2 changes: 1 addition & 1 deletion cvp/accesspoint_config_generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down
2 changes: 1 addition & 1 deletion cvp/accesspoint_location_config_generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down
34 changes: 17 additions & 17 deletions cvp/accesspoints_configuration_provisioning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down Expand Up @@ -517,37 +517,37 @@ response:

#### **b. Mapping config to UI Actions.**
- Select Workflows to enter the workflows page
![alt text](./images/configuretion_ap_1.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_1.png)
- On the workflows page, search for "Configure Access Points" -> Select the task "Configure Access Points".
![alt text](./images/configuretion_ap_2.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_2.png)
- On the Get Started page, enter Task Name -> Next.
![alt text](./images/configuretion_ap_3.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_3.png)
- Perform some options for the Configurre Access Points section including Radio and Steps.
![alt text](./images/configuretion_ap_4.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_4.png)
- On the Selected Access Points page, select the Access Point you want to configure.
![alt text](./images/configuretion_ap_5.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_5.png)
- On the Selected Access Points page, select the Access Point you want to configure -> Next.
![alt text](./images/configuretion_ap_6.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_6.png)
- On the Configure AP Parameters page, perform the options you want to configure -> Next.
![alt text](./images/configuretion_ap_7.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_7.png)
- On the Configure 5 GHZ Radio Rarameters page, perform the options you want to configure (This page is only displayed if you select configure 5 GHz) -> Next.
![alt text](./images/configuretion_ap_8.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_8.png)
- On the Configure 2.4 GHZ Radio Rarameters page, perform the options you want to configure (This page is only displayed if you select configure 2.4 GHz) -> Next. Note, for Access Points that cannot configure 2.4 GHZ Radio Rarameters, this page is still displayed but you cannot configure.
![alt text](./images/configuretion_ap_9.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_9.png)
- On the Configure 6 GHZ Radio Rarameters page, perform the options you want to configure (This page is only displayed if you choose to configure 6 GHz) -> Next. Note, for Access Points that cannot configure 6 GHZ Radio Rarameters, this page is still displayed but you cannot configure.
![alt text](./images/configuretion_ap_10.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_10.png)
- On the Configure Dual-Band (XOR) Radio Rarameters page, perform the options you want to configure (This page is only displayed if you choose to configure Dual-Band (XOR) ) -> Next.
![alt text](./images/configuretion_ap_11.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_11.png)
- On the Configure Tri-Radio Rarameters page, perform the options you want to configure (This page is only displayed if you choose to configure Tri-Radio ) -> Next.
![alt text](./images/configuretion_ap_12.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_12.png)
- On the Save As Reusable Template page, enter Template Name -> Next to save the task name.
![alt text](./images/configuretion_ap_13.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_13.png)
- On the Summary page, check the selected parameters -> Next
![alt text](./images/configuretion_ap_14.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_14.png)
A- t the Provision Schedule, enter Task Name -> Configure.
![alt text](./images/configuretion_ap_15.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_15.png)
- Finally, check Preview Configuration -> Deploy.
![alt text](./images/configuretion_ap_16.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/accesspoints_configuration_provisioning/images/configuretion_ap_16.png)

### 2. Creating Bulk Accesspoint Configuration using JINJA template and using the playbook:
#### a. JINJA Template
Expand Down
2 changes: 1 addition & 1 deletion cvp/ansible_vault_update/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down
14 changes: 7 additions & 7 deletions cvp/application_policy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down Expand Up @@ -222,11 +222,11 @@ A. Create Queuing Profile (state: merged)

Image with bandwidth_settings input on UI:

![alt text](images/create_queuing_profiles.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/application_policy/images/create_queuing_profiles.png)

Image with dscp_settings input on UI:

![alt text](images/create_queuing_profiles_dscp.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/application_policy/images/create_queuing_profiles_dscp.png)

This example defines two queuing profiles to classify and prioritize different types of network traffic:

Expand Down Expand Up @@ -348,7 +348,7 @@ C. Create Application (state: merged):

Image add Application on UI:

![alt text](images/create_application.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/application_policy/images/create_application.png)

This example defines two applications for network traffic identification:

Expand Down Expand Up @@ -438,7 +438,7 @@ E. Create Application Policy (state: merged):

Image add Application Policy on UI:

![alt text](images/create_application_policy.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/application_policy/images/create_application_policy.png)

This example creates two application policies:

Expand Down Expand Up @@ -614,11 +614,11 @@ After executing the playbook, check the Catalyst Center UI to verify switch prof

- Verify Queuing Profiles:

![alt text](images/queuing_profiles.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/application_policy/images/queuing_profiles.png)

- Verify Application Policy:

![alt text](images/application_policy1.png)
![alt text](https://raw.githubusercontent.com/cisco-en-programmability/catalystcenter-ansible/main/cvp/application_policy/images/application_policy1.png)

## References

Expand Down
2 changes: 1 addition & 1 deletion cvp/application_policy_config_generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ flowchart TD
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install catalystcentersdk
ansible-galaxy collection install cisco.catalystcenter --force
```

Expand Down
Loading
Loading