- Install Python 3.8 or later
- Install ansible-core from 2.11.3 to 2.14.x excluding 2.12.0 to 2.12.5 and 2.13.0
Excluded versions have an issue in
ansible-core, which is fixed in 2.12.6 and 2.13.1. Plugin loader will now load config data for plugin by name instead of by file to avoid issues with the same file being loaded under different names (Fully-Qualified-Collection-Name + short-name).
- Install arista.avd collection
- Install additional Python requirements
ansible.cfgfile to support additional jinja2 extensions
Install Collection from Ansible Galaxy¶
These instructions are for regular users to install via Ansible Galaxy. To setup a development environment use these instructions. arista.avd can also be consumed using the “AVD All-in-one” container. The arista.avd collection is available on Ansible Galaxy server and can be automatically installed on your system.
If you have an
ansible.cfg file in the directory where you run
ansible-galaxy, it may affect the directory under which the collection and dependencies will be installed.
Install a specific version¶
You can specify multiple range identifiers which are split by
,. For example, you can use the following range identifiers:
*: Any version, this is the default used when no range specified is set.
!=: Version isn’t equal to the one specified.
==: Version must be the one specified.
>=: Version is greater than or equal to the one specified.
>: Version is greater than the one specified.
<=: Version is less than or equal to the one specified.
<: Version is less than the one specified.
If you are installing with a range command, you must surround the command in quotes. For example,
ansible-galaxy collection install 'arista.avd:>=3.0.0,<3.6.0'
devel version from AVD GitHub¶
Collection dependencies like
ansible-cvp will be installed from ansible-galaxy unless installed first using similar GitHub source.
Install in a specific directory¶
If you want to install collection in a specific directory part of your project, you can call
ansible-galaxy and update your
Upgrade installed AVD collection¶
You can use
-U to upgrade to a new version for any installed collection:
You can find some additional information about how to use Ansible’s collections on the following Ansible pages:
Additional Python Libraries required¶
Python requirements installation¶
In a shell, run the following commands after installing the collection from ansible-galaxy:
If the collection is cloned from GitHub, we can reference the requirements file directly:
Depending of your operating system settings,
pip3 might be replaced by
Ansible configuration file¶
- Enable Jinja2 extensions:
- By default, Ansible will issue a warning when a duplicate dict key is encountered in YAML. We recommend to change to error instead and stop playbook execution when a duplicate key is detected.
Arista EOS requirements¶
- EOS 4.21.8M or later
- Roles validated with eAPI transport ->
Arista CloudVision requirements¶
When using ansible-cvp modules, the user who is executing the ansible-playbook must have access to both CVP and the EOS CLI.