The ansible-aci project provides an Ansible collection for managing and automating your Cisco Application Centric Infrastructure (ACI) environment. It consists of a set of modules and roles for performing tasks related to ACI.
See the cisco.aci collection index for a full list of modules and plugins.
- Ansible v2.16 or newer
- Python v3.11 or newer
Follow the Installing Ansible guide for detailed instructions.
Before using this collection, you need to install it with the Ansible Galaxy command-line tool:
ansible-galaxy collection install cisco.aciYou can also include this collection in a requirements.yml file and install it with:
ansible-galaxy collection install -r requirements.ymlUsing the following requirements.yml format:
collections:
- name: cisco.aciNote that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:
ansible-galaxy collection install cisco.aci --upgradeYou can also install a specific version of the collection. For example, to install version 1.0.0, use the following syntax:
ansible-galaxy collection install cisco.aci:==1.0.0See using Ansible collections for more details.
Follow these instructions to get the latest collection.
Clone the ansible-aci repository.
git clone https://github.com/CiscoDevNet/ansible-aci.gitGo to the ansible-aci directory
cd ansible-aciPull the latest master on your aci
git pull origin masterBuild and Install a collection from source
ansible-galaxy collection build --force
ansible-galaxy collection install cisco-aci-* --forceGo to ansible-aci Actions and select the latest CI build.
Under Artifacts download collection suffixed with the latest version of Ansible (eg. collection-stable-2.17) 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-aci-1.0.0.tar.gz —-forceOnce the collection is installed, you can use it in a playbook by specifying the full namespace path to the module, plugin and/or role.
- hosts: aci
gather_facts: no
tasks:
- name: Add a new EPG
cisco.aci.aci_epg:
hostname: apic
username: admin
password: SomeSecretPassword
tenant: production
ap: intranet
epg: web_epg
description: Web Intranet EPG
bd: prod_bd
delegate_to: localhostThere are two main methods to optimize the execution of ACI modules in your playbooks.
- Using the ACI HTTPAPI plugin
- Using the
suppress_options
To find out more about optimizing playbook execution, please refer to the Optimizing Playbooks documentation.
Integration tests for each module in the cisco.aci collection are executed on the following ACI versions:
- 4.2
- 5.2
- 6.0
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 ACI collection repository.
This collection supports any ACI version within the Last Day of Support (LDOS) date.
Certain modules and options in the collection are only available from specific versions of ACI. The versions that a module or option supports are documented in the individual module documentation.
To find EOL announcements for ACI versions, refer to the End-of-Life and End-of-Sale Notices page.
See the Changelog for full release notes.
For further information and guides, refer to the following:
This collection is licensed under the GNU General Public License v3.0