diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 16:03:42 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 16:03:42 +0000 |
commit | 66cec45960ce1d9c794e9399de15c138acb18aed (patch) | |
tree | 59cd19d69e9d56b7989b080da7c20ef1a3fe2a5a /ansible_collections/cisco/mso/README.md | |
parent | Initial commit. (diff) | |
download | ansible-66cec45960ce1d9c794e9399de15c138acb18aed.tar.xz ansible-66cec45960ce1d9c794e9399de15c138acb18aed.zip |
Adding upstream version 7.3.0+dfsg.upstream/7.3.0+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/cisco/mso/README.md')
-rw-r--r-- | ansible_collections/cisco/mso/README.md | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/ansible_collections/cisco/mso/README.md b/ansible_collections/cisco/mso/README.md new file mode 100644 index 00000000..c45d72ea --- /dev/null +++ b/ansible_collections/cisco/mso/README.md @@ -0,0 +1,115 @@ +# ansible-mso + +The `ansible-mso` project provides an Ansible collection for managing and automating your Cisco ACI Multi-Site environment. +It consists of a set of modules and roles for performing tasks related to ACI Multi-Site. + +This collection has been tested and supports MSO 2.1+. +Modules supporting new features introduced in MSO API in specific MSO versions might not be supported in earlier MSO releases. + +*Note: This collection is not compatible with versions of Ansible before v2.8.* + +## Requirements +- Ansible v2.9 or newer + +## Install +Ansible must be installed +``` +sudo pip install ansible +``` + +Install the collection +``` +ansible-galaxy collection install cisco.mso +``` + +## Use +Once the collection is installed, you can use it in a playbook by specifying the full namespace path to the module, plugin and/or role. +```yaml +- hosts: mso + gather_facts: no + + tasks: + - name: Add a new site EPG + cisco.mso.mso_schema_site_anp_epg: + host: mso_host + username: admin + password: SomeSecretPassword + schema: Schema1 + site: Site1 + template: Template1 + anp: ANP1 + epg: EPG1 + state: present + delegate_to: localhost +``` + +You can also use the MSO HTTPAPI connection plugin by setting the following variables in your inventory file (cisco.mso collection v1.2+). +```yaml +ansible_connection=ansible.netcommon.httpapi +ansible_network_os=cisco.mso.mso +``` + +The 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. +```yaml +ansible_host=10.0.0.1 +ansible_user=admin +ansible_ssh_pass="MySuperPassword" +ansible_httpapi_validate_certs=False +ansible_httpapi_use_ssl=True +ansible_httpapi_use_proxy=True +``` + +You can also use the Nexus Dashboard (ND) connection plugin available in the [cisco.nd](https://galaxy.ansible.com/cisco/nd) collection by changing the following variable. +```yaml +ansible_connection=ansible.netcommon.httpapi +ansible_network_os=cisco.nd.nd +``` + +## Update +Getting the latest/nightly collection build + +### First Approach +Clone the ansible-mso repository. +``` +git clone https://github.com/CiscoDevNet/ansible-mso.git +``` + +Go to the ansible-mso directory +``` +cd ansible-mso +``` + +Pull the latest master on your mso +``` +git pull origin master +``` + +Build and Install a collection from source +``` +ansible-galaxy collection build --force +ansible-galaxy collection install cisco-mso-* --force +``` + +### Second Approach +Go to: https://github.com/CiscoDevNet/ansible-mso/actions + +Select the latest CI build + +Under Artifacts download collection and unzip it using Terminal or Console. + +*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.* + +Install the unarchived tar.gz file +``` +ansible-galaxy collection install cisco-mso-1.0.0.tar.gz —-force +``` + +### See Also: + +* [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details. + +## Contributing to this collection + +Ongoing development efforts and contributions to this collection are tracked as issues in this repository. + +We 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). |