README.md

Ansible Collection For Arista Validated Designs - arista.avd

Table of Contents:

• Ansible Collection For Arista Validated Designs - arista.avd
  • About
  • Reference Designs
  • Project Documentation
  • Installation
    • Requirements
    • Installation from ansible-galaxy
  • Example Playbooks
  • Examples
  • Additional Resources
  • Ask a question
  • Contributing
  • Branching Model
  • License

About

Arista Networks supports Ansible for managing devices running the EOS operating system natively through eapi or CloudVision Portal (CVP). This collection includes a set of ansible roles and modules to help kick-start your automation with Arista. The various roles and templates provided are designed to be customized and extended to your needs!

Reference Designs

The arista.avd collection provides abstracted data models and framework to build, document, deploy and validate the following designs:

L3LS EVPN:

Underlay	Overlay	Topology
eBGP	eBGP	Multi-Stage + L2 Leafs
ISIS	eBGP	Multi-Stage + L2 Leafs
ISIS	iBGP	Multi-Stage + L2 Leafs
OSPF	eBGP	Multi-Stage + L2 Leafs
OSPF	iBGP	Multi-Stage + L2 Leafs
RFC5549(eBGP)	eBGP	Multi-Stage + L2 Leafs

Project Documentation

The documentation how to leverage ansible-avd collection is located here:

• Read The Docs
• GitHub

Installation

Requirements

Arista EOS:

• EOS 4.21.8M or later
• Roles validated with eAPI transport -> ansible_connection: httpapi

Python:

• Python 3.8 or later

Supported Ansible Versions:

• ansible-core from 2.11.3 to 2.12.x

Additional Python Libraries required:

• netaddr
• Jinja2
• treelib
• cvprac
• paramiko
• jsonschema
• requests
• PyYAML
• md-toc

Ansible + Additional Python Libraries Installation:

$ pip3 install ansible-core>=2.11.3,<2.13.0

$ pip3 install -r ansible_collections/arista/avd/requirements.txt

Ansible Configuration INI file:

• enable jinja2 extensions: loop controls and do
  • Jinja2 Extensions Documentation
• 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.

jinja2_extensions=jinja2.ext.loopcontrols,jinja2.ext.do
duplicate_dict_key=error

NOTE: When using ansible-cvp modules, the user that is executing the ansible-playbook has to have access to both CVP and the EOS CLI.

Installation from ansible-galaxy

Ansible galaxy hosts all stable version of this collection. Installation from ansible-galaxy is the most convenient approach for consuming arista.avd content

ansible-galaxy collection install arista.avd

Example Playbooks

An example playbook to deploy VXLAN/EVPN Fabric via CloudVision:

- hosts: DC1_FABRIC
  tasks:

    - name: generate intended variables
      import_role:
         name: arista.avd.eos_designs

    - name: generate device intended config and documentation
      import_role:
         name: arista.avd.eos_cli_config_gen

- hosts: CVP
  tasks:

  - name: upload cvp configlets
    import_role:
        name: arista.avd.cvp_configlet_upload
    vars:
      configlet_directory: 'configlets/'
      file_extension: 'txt'
      configlets_cvp_prefix: 'DC1-AVD'

    - name: deploy configuration via CVP
      import_role:
         name: arista.avd.eos_config_deploy_cvp

Execute eos_state_validation playbook once change control has been approved and deployed to devices in CVP. Note: To run this playbook, ansible_host must be configured in your inventory for every EOS device. eAPI access must be configured and allowed in your networks.

- hosts: DC1_FABRIC

  tasks:

    - name: audit fabric state using EOS eAPI connection
      import_role:
         name: arista.avd.eos_validate_state

An example playbook to deploy VXLAN/EVPN Fabric via eAPI:

- hosts: DC1_FABRIC

  tasks:

    - name: generate intended variables
      import_role:
         name: arista.avd.eos_designs

    - name: generate device intended config and documentation
      import_role:
         name: arista.avd.eos_cli_config_gen

    - name: deploy configuration via eAPI
      import_role:
         name: arista.avd.eos_config_deploy_eapi

    - name: audit fabric state using EOS eAPI connection
      import_role:
         name: arista.avd.eos_validate_state

Examples

Full examples with variables and outputs, are located here:

Arista NetDevOps Examples

Additional Resources

• Ansible EOS modules on ansible documentation.
• Ansible CloudVision modules
• CloudVision Portal
• Arista Design and Deployment Guides

Ask a question

Support for this arista.avd collection is provided by the community directly in this repository. Easiest way to get support is to open an issue.

Contributing

Contributing pull requests are gladly welcomed for this repository. If you are planning a big change, please start a discussion first to make sure we'll be able to merge it.

You can also open an issue to report any problem or to submit enhancement.

Branching Model

• The devel branch corresponds to the release actively under development.
• The releases/x.x.x branches correspond to stable releases.
• Fork repository and create a branch based on devel to set up a dev environment if you want to open a PR.
• See the ansible-avd release for information about active branches.

License

Project is published under Apache 2.0 License