{"id":37883051,"url":"https://github.com/cisco-en-programmability/catalystcenter-ansible","last_synced_at":"2026-06-27T02:04:53.209Z","repository":{"id":292408860,"uuid":"870271001","full_name":"cisco-en-programmability/catalystcenter-ansible","owner":"cisco-en-programmability","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-12T04:41:47.000Z","size":47083,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-02-12T19:24:31.343Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cisco-en-programmability.png","metadata":{"files":{"readme":"README.md","changelog":"changelogs/changelog.yaml","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-10-09T18:30:02.000Z","updated_at":"2026-02-12T03:48:30.000Z","dependencies_parsed_at":"2026-02-11T20:10:46.578Z","dependency_job_id":null,"html_url":"https://github.com/cisco-en-programmability/catalystcenter-ansible","commit_stats":null,"previous_names":["cisco-en-programmability/catalystcenter-ansible"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/cisco-en-programmability/catalystcenter-ansible","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-en-programmability%2Fcatalystcenter-ansible","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-en-programmability%2Fcatalystcenter-ansible/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-en-programmability%2Fcatalystcenter-ansible/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-en-programmability%2Fcatalystcenter-ansible/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cisco-en-programmability","download_url":"https://codeload.github.com/cisco-en-programmability/catalystcenter-ansible/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-en-programmability%2Fcatalystcenter-ansible/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29927628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"online","status_checked_at":"2026-02-28T02:00:07.010Z","response_time":90,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-16T16:49:55.210Z","updated_at":"2026-02-28T07:37:33.901Z","avatar_url":"https://github.com/cisco-en-programmability.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Ansible Collection: cisco.catalystcenter\n\n## Overview\n\nThe cisco.catalystcenter Ansible Collection enables enterprise automation and management of Cisco CATALYST Center environments. It provides modules that interact with Cisco CATALYST Center APIs to automate provisioning, configuration, and operational workflows.\n\nThis collection is available on both [Ansible Galaxy](https://galaxy.ansible.com/cisco/catalystcenter) and [Red Hat Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/cisco/catalystcenter/).\n\n\n## Compatibility Matrix\n\nThe following table shows the supported versions.\n\n| Cisco CATALYST Center version | Ansible \"cisco.catalystcenter\" version | Python \"catalystcentersdk\" version |\n|-------------------------------|----------------------------------------|------------------------------------|\n|2.3.7.6|1.0.0|2.3.7.6.2|\n|2.3.7.9|2.1.4|2.3.7.9.5|\n|3.1.3.0|2.2.2|3.1.3.0.1|\n|3.1.6.0|2.3.x|3.1.3.6.x|\n\nIf your Ansible collection is older please consider updating it first.\n\nNotes:\n\n1. The \"Python 'catalystcentersdk' version\" column has the minimum recommended version used when testing the Ansible collection. This means you could use later versions of the Python \"catalystcentersdk\" than those listed.\n2. The \"Cisco CATALYST Center version\" column has the value of the `version` you should use for the Ansible collection.\n\n\n## Requirements\n\n- Python \u003e= 3.12\n- [catalystcentersdk](https://github.com/cisco-en-programmability/catalystcentersdk) (see Compatibility Matrix for tested versions)\n- ansible-core \u003e= 2.16\n\n\u003e **Note:** ansible-core is provided through Red Hat Ansible Automation Platform Execution Environments or can be installed via standard enterprise channels. Manual installation is not required for certified environments.\n\n\n\n## Installation\n\nInstall the collection from Ansible Galaxy or Automation Hub:\n\n```bash\nansible-galaxy collection install cisco.catalystcenter\n```\n\nTo upgrade to the latest version:\n\n```bash\nansible-galaxy collection install cisco.catalystcenter --upgrade\n```\n\n\nInstall the Python SDK:\n\n```bash\npip install catalystcentersdk\n```\n\n\n\n## Using this Collection\n\nConnection details can be provided via environment variables or Ansible variable files. See the [examples directory](https://github.com/cisco-en-programmability/catalystcenter-ansible/tree/main/playbooks) for sample playbooks and variable files.\n\n### Using environment variables\n\nFirst, export the environment variables where you specify your CATALYST Center credentials as ansible variables:\n\n```bash\nexport CATALYSTCENTER_HOST=\u003cA.B.C.D\u003e\nexport CATALYSTCENTER_PORT=443 # optional, defaults to 443\nexport CATALYSTCENTER_USERNAME=\u003cusername\u003e\nexport CATALYSTCENTER_PASSWORD=\u003cpassword\u003e\nexport CATALYSTCENTER_VERSION=3.1.3.0 # optional, see the Compatibility matrix\nexport CATALYSTCENTER_VERIFY=False # optional, defaults to True\nexport CATALYSTCENTER_DEBUG=False # optional, defaults to False\n```\n\nCreate 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:\n\n```ini\n[catalystcenter_servers]\ncatalystcenter_server\n```\n\nThen, create a playbook `myplaybook.yml` ([example](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/playbooks/tag.yml)) specifying the full namespace path to the module, plugin and/or role. The module will read connection details from the environment variables above:\n\n```yaml\n- hosts: catalystcenter_servers\n  gather_facts: false\n  tasks:\n  - name: Create tag with name \"MyNewTag\"\n    cisco.catalystcenter.tag:\n      state: present\n      description: My Tag\n      name: MyNewTag\n    register: result\n```\n\nExecute the playbook:\n\n```bash\nansible-playbook -i hosts myplaybook.yml\n```\n\n### Using vars_files\n\nFirst, 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:\n\n```yaml\n---\ncatalystcenter_host: \u003cA.B.C.D\u003e\ncatalystcenter_port: 443  # optional, defaults to 443\ncatalystcenter_username: \u003cusername\u003e\ncatalystcenter_password: \u003cpassword\u003e\ncatalystcenter_version: 3.1.6.0  # optional, see the Compatibility matrix\ncatalystcenter_verify: False  # optional, defaults to True\ncatalystcenter_debug: False  # optional, defaults to False\n```\n\nCreate 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:\n\n```ini\n[catalystcenter_servers]\ncatalystcenter_server\n```\n\nThen, create a playbook `myplaybook.yml` ([example](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/playbooks/tag.yml)) referencing the variables in your credentials.yml file and specifying the full namespace path to the module, plugin and/or role:\n\n```yaml\n- hosts: catalystcenter_servers\n  vars_files:\n    - vars/credentials.yml\n  gather_facts: false\n  tasks:\n  - name: Create tag with name \"MyNewTag\"\n    cisco.catalystcenter.tag:\n      catalystcenter_host: \"{{ catalystcenter_host }}\"\n      catalystcenter_username: \"{{ catalystcenter_username }}\"\n      catalystcenter_password: \"{{ catalystcenter_password }}\"\n      catalystcenter_verify: \"{{ catalystcenter_verify }}\"\n      catalystcenter_port: \"{{ catalystcenter_port }}\"\n      catalystcenter_version: \"{{ catalystcenter_version }}\"\n      catalystcenter_debug: \"{{ catalystcenter_debug }}\"\n      state: present\n      description: My Tag\n      name: MyNewTag\n    register: result\n```\n\nExecute the playbook:\n\n```bash\nansible-playbook -i hosts myplaybook.yml\n```\n\nIn the `playbooks` [directory](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/playbooks) you can find more examples and use cases.\n\n\n## Use Cases\n\n\nThis collection supports automation scenarios such as:\n\n- Automating device and site configuration through Cisco CATALYST Center APIs.\n- Managing tags, sites, templates, and policies programmatically.\n- Querying inventory and operational data for reporting and validation workflows.\n- Integrating Cisco CATALYST Center operations into CI/CD or ITSM workflows.\n- Standardizing repeatable infrastructure changes using playbooks.\n\n\n## Testing\n\nThis collection is validated against the following environments:\n\n- Cisco CATALYST Center: 2.3.7.6, 2.3.7.9, 3.1.3.0, 3.1.6.0\n- ansible-core: \u003e= 2.16\n- Python: \u003e= 3.12\n\nKnown limitations and compatibility notes are documented in the [changelog](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/changelogs/changelog.yaml). For platform-specific issues, consult the official documentation or open a support case as appropriate.\n\n\n\n## Contributing\n\nContributions are welcome. Please open issues or pull requests via the [Cisco CATALYST Center Ansible collection repository](https://github.com/cisco-en-programmability/catalystcenter-ansible/issues). All contributors must adhere to the project's Code of Conduct.\n\n\n## Code of Conduct\n\nThis collection follows the Ansible project's\n[Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).\nPlease read and familiarize yourself with this document.\n\n\n## Support\n\nThis collection is available on both Ansible Galaxy and Red Hat Automation Hub.\n\nFor certified content obtained from Red Hat Automation Hub, support is provided through Red Hat Ansible Automation Platform according to your subscription agreement.\n\nFor content obtained from Ansible Galaxy, community support may be available via:\n- [Ansible Forum](https://forum.ansible.com/)\n- [GitHub Issues](https://github.com/cisco-en-programmability/catalystcenter-ansible/issues)\n\nPlease consult your platform documentation for support eligibility and procedures.\n\n---\n\n\n## Release Notes and Roadmap\n\nRelease notes are maintained in the public [changelog](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/changelogs/changelog.yaml).\n\nThis collection follows [Semantic Versioning](https://semver.org/). For roadmap information, refer to the repository or contact Cisco for enterprise roadmap details.\n\n---\n\n\n## Related Information\n\n- [Catalyst Center Python SDK](https://github.com/cisco-en-programmability/catalystcentersdk)\n- [Using Ansible Collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html)\n- [Catalyst Center Ansible Collection](https://github.com/cisco-en-programmability/catalystcenter-ansible)\n\n---\n\n\n## License\n\nThis collection is licensed under the Cisco Sample Code License.\n\nThe full license text is available in the [LICENSE](https://github.com/cisco-en-programmability/catalystcenter-ansible/blob/main/LICENSE) file.\n\nThe license is included in the distributed collection artifact.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcisco-en-programmability%2Fcatalystcenter-ansible","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcisco-en-programmability%2Fcatalystcenter-ansible","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcisco-en-programmability%2Fcatalystcenter-ansible/lists"}