{"id":20588638,"url":"https://github.com/ciscodevnet/ansible-mso","last_synced_at":"2025-09-01T01:11:31.443Z","repository":{"id":37974084,"uuid":"221995654","full_name":"CiscoDevNet/ansible-mso","owner":"CiscoDevNet","description":"Cisco MSO Ansible Collection","archived":false,"fork":false,"pushed_at":"2025-08-27T16:51:16.000Z","size":2987,"stargazers_count":30,"open_issues_count":30,"forks_count":34,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-08-29T21:40:27.206Z","etag":null,"topics":["ansible-collection"],"latest_commit_sha":null,"homepage":"https://galaxy.ansible.com/cisco/mso","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/CiscoDevNet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-11-15T20:11:12.000Z","updated_at":"2025-08-27T16:50:54.000Z","dependencies_parsed_at":"2023-12-20T21:37:02.153Z","dependency_job_id":"54af0b0d-2a43-4b2a-9670-924c84e1aaa6","html_url":"https://github.com/CiscoDevNet/ansible-mso","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/CiscoDevNet/ansible-mso","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fansible-mso","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fansible-mso/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fansible-mso/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fansible-mso/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CiscoDevNet","download_url":"https://codeload.github.com/CiscoDevNet/ansible-mso/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fansible-mso/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273061076,"owners_count":25038596,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"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":["ansible-collection"],"created_at":"2024-11-16T07:25:41.624Z","updated_at":"2025-09-01T01:11:31.421Z","avatar_url":"https://github.com/CiscoDevNet.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ansible-mso\n\n## Description\n\nThe `ansible-mso` project provides an Ansible collection for managing and automating your Cisco ACI Multi-Site or Nexus Dashboard Orchestrator environments.\nIt consists of a set of modules and roles for performing tasks related to ACI Multi-Site.\n\nSee the [cisco.mso collection index](https://galaxy.ansible.com/ui/repo/published/cisco/mso/content/) for a full list of modules and plugins.\n\n*Note: The Nexus Dashboard (ND) HTTPAPI connection plugin should be used when Cisco ACI Multi-Site is installed on Nexus Dashboard (v3.2+) or when using this collection with Nexus Dashboard Orchestrator (v3.6+).*\n\n## Requirements\n\n- Ansible v2.16 or newer\n- Python v3.11 or newer\n\nFollow the [Installing Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) guide for detailed instructions.\n\n## Installation\n\nBefore using this collection, you need to install it with the Ansible Galaxy command-line tool:\n\n```sh\nansible-galaxy collection install cisco.mso\n```\n\nYou can also include this collection in a requirements.yml file and install it with:\n\n```sh\nansible-galaxy collection install -r requirements.yml\n```\n\nUsing the following `requirements.yml` format:\n\n```yaml\ncollections:\n  - name: cisco.mso\n```\n\nNote that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package.\nTo upgrade the collection to the latest available version, run the following command:\n\n```sh\nansible-galaxy collection install cisco.mso --upgrade\n```\n\nYou can also install a specific version of the collection. For example, to install version 1.0.0, use the following syntax:\n\n```sh\nansible-galaxy collection install cisco.mso:==1.0.0\n```\n\nSee [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.\n\n### Installation with Nexus Dashboard\n\nInstall the Nexus Dashboard (ND) collection when Cisco ACI Multi-Site is installed on Nexus Dashboard (v3.2+) or when using this collection with Nexus Dashboard Orchestrator (v3.6+)\n\n```sh\nansible-galaxy collection install cisco.nd\n```\n\n### Latest Build\n\nFollow these instructions to get the latest collection.\n\n#### First Approach - Build From Source Code\n\nClone the `ansible-mso` repository.\n\n```sh\ngit clone https://github.com/CiscoDevNet/ansible-mso.git\n```\n\nGo to the `ansible-mso` directory\n\n```sh\ncd ansible-mso\n```\n\nPull the latest master on your mso\n\n```sh\ngit pull origin master\n```\n\nBuild and Install a collection from source\n\n```sh\nansible-galaxy collection build --force\nansible-galaxy collection install cisco-mso-* --force\n```\n\n#### Second Approach - Download From Latest CI Build\n\nGo to [ansible-mso Actions](https://github.com/CiscoDevNet/ansible-mso/actions/workflows/ansible-test.yml?query=branch%3Amaster) and select the latest CI build.\n\nUnder Artifacts download collection suffixed with the latest version of Ansible (eg. `collection-stable-2.17`) and unzip it using Terminal or Console.\n\n*Note: The collection file is a zip file containing a tar.gz file. We recommend using CLI because some GUI-based unarchiver might unarchive both nested archives in one go.*\n\nInstall the unarchived tar.gz file\n\n```sh\nansible-galaxy collection install cisco-mso-1.0.0.tar.gz —-force\n```\n\n## Use Cases\n\nOnce the collection is installed, you can use it in a playbook by specifying the full namespace path to the module, plugin and/or role.\n\n### Adding a new site EPG\n\n```yaml\n- hosts: mso\n  gather_facts: no\n\n  tasks:\n  - name: Add a new site EPG\n    cisco.mso.mso_schema_site_anp_epg:\n      host: mso_host\n      username: admin\n      password: SomeSecretPassword\n      schema: Schema1\n      site: Site1\n      template: Template1\n      anp: ANP1\n      epg: EPG1\n      state: present\n```\n\n## MSO HTTPAPI Plugin\n\nYou can use the MSO HTTPAPI connection plugin by setting the following variables in your inventory file (cisco.mso collection v1.2+).\n\n```yaml\nansible_connection=ansible.netcommon.httpapi\nansible_network_os=cisco.mso.mso\n```\n\nThe HTTPAPI connection plugin will also allow you to specify additional parameters as variable and omit them from the task itself. Module parameters will override global variables.\n\n```yaml\nansible_host=10.0.0.1\nansible_user=admin\nansible_ssh_pass=\"MySuperPassword\"\nansible_httpapi_validate_certs=False\nansible_httpapi_use_ssl=True\nansible_httpapi_use_proxy=True\n```\n\nYou should use the Nexus Dashboard (ND) collection plugin, which is available in the [cisco.nd](https://galaxy.ansible.com/cisco/nd) collection, when Cisco ACI Multi-Site is installed on Nexus Dashboard (v3.2+) or when using this collection with Nexus Dashboard Orchestrator (v3.6+) by changing the following variables.\n\n```yaml\nansible_connection=ansible.netcommon.httpapi\nansible_network_os=cisco.nd.nd\nansible_httpapi_use_ssl=True\n```\n\n## Testing\n\nIntegration tests for each module in the `cisco.mso` collection are executed on the following Nexus Dashboard Orchestrator versions:\n\n- 3.7\n- 4.1\n- 4.2\n- 4.3\n\n## Contributing\n\nOngoing development efforts and contributions to this collection are tracked as issues in this repository.\n\nWe welcome community contributions to this collection. If you find problems, need an enhancement or need a new module, please open an issue or create a PR against the [Cisco MSO collection repository](https://github.com/CiscoDevNet/ansible-mso/issues).\n\n## Support\n\nThis collection supports any MSO/NDO version within the Last Day of Support (LDOS) date.\n\nCertain modules and options in the collection are only available from specific versions of MSO/NDO. The versions that a module or option supports are documented in the individual module documentation.\n\nTo find EOL announcements for MSO/NDO versions, refer to the [End-of-Life and End-of-Sale Notices](https://www.cisco.com/c/en/us/products/cloud-systems-management/multi-site-orchestrator/eos-eol-notice-listing.html) page.\n\n## Release Notes\n\nSee the [Changelog](https://github.com/CiscoDevNet/ansible-mso/blob/master/CHANGELOG.rst) for full release notes.\n\n## Related Information\n\nFor further information, refer to the following:\n\n- [Automating Cisco MSO with Ansible Learning Lab](https://developer.cisco.com/learning/labs/mso-ansible_part1-intro/setup-an-ansible-and-mso-environment/)\n- [Nexus Dashboard Orchestrator Overview](https://www.cisco.com/c/en/us/products/collateral/cloud-systems-management/multi-site-orchestrator/nb-06-mso-so-cte-en.html)\n- [Nexus Dashboard Orchestrator Support Documentation](https://www.cisco.com/c/en/us/support/cloud-systems-management/multi-site-orchestrator/series.html)\n- [Nexus Dashboard Orchestrator API Release Notes](https://developer.cisco.com/docs/search/?q=Nexus+Dashboard+Orchestrator)\n\n## License Information\n\nThis collection is licensed under the [GNU General Public License v3.0](https://github.com/CiscoDevNet/ansible-mso/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fansible-mso","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fciscodevnet%2Fansible-mso","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fansible-mso/lists"}