• Ansible Modules for Arista CloudVision Platform
  • About
  • Modules overview
    • Important notes.
  • Installation
    • Dependencies
    • Git installation for testing
    • Git installation
    • Docker for testing
  • Example playbook
  • Resources
  • License
  • Ask a question
  • Contributing

Arista Networks supports Ansible for managing devices running the EOS operating system through CloudVision platform (CVP). This roles includes a set of ansible modules that perform specific configuration tasks on CVP server. These tasks include: collecting facts, managing configlets, containers, build provisionning topology and running tasks. For installation, you can refer to specific section of this readme.

This repository provides content for Ansible's collection arista.cvp with following content:

• arista.cvp.cv_facts - Collect CVP facts from server like list of containers, devices, configlet and tasks.
• arista.cvp.cv_configlet - Manage configlet configured on CVP.
• arista.cvp.cv_container - Manage container topology and attach configlet and devices to containers.
• arista.cvp.cv_device - Manage devices configured on CVP
• arista.cvp.cv_task - Run tasks created on CVP.

This collection supports CVP version 2018.2.x and 2019.1.x

This repository is built based on new collections system introduced by ansible starting version 2.9.

It means that it is required to run at least ansible 2.9.0rc4 to be able to use this collection.

This collection requires the following to be installed on the Ansible control machine:

• python 2.7 and 3.x
• ansible >= 2.9.0rc4
• requests >= 2.22.0
• treelib version 1.5.5 or later

You can git clone this repository and use examples folder for testing. This folder contains a set of pre-configured playbook and ansible configuration:

$ git clone https://github.com/aristanetworks/ansible-cvp.git
$ cd ansible-cvp/examples
$ make build

It is highly recommended to use a python virtual-environment to not alter your production environment.

You can git clone this repository and use examples folder for testing. This folder contains a set of pre-configured playbook and ansible configuration:

Clone repository

$ git clone https://github.com/aristanetworks/ansible-cvp.git
$ cd ansible-cvp

Build and install collection

$ ansible-galaxy collection build --force arista/cvp
$ ansible-galaxy collection install arista.cvp.*.tar.gz

The docker container approach for development can be used to ensure that everybody is using the same development environment while still being flexible enough to use the repo you are making changes in. You can inspect the Dockerfile to see what packages have been installed.

• Build Docker with Python 2.7

$ docker build -f Dockerfile-2.7 -t ansible-cvp:latest2.7 .
$ docker exec -it --rm ansible-cvp:latest2.7 sh

• Build Docker with Python 3.x

$ docker build -f Dockerfile-3 -t ansible-cvp:latest3 .
$ docker exec -it --rm ansible-cvp:latest3 sh

Docker images can be reduced by using --squash option available with experimental features enabled on your docker host.

All files part of examples are copied into the container.

This example outlines how to use arista.cvp to create a containers topology on Arista CloudVision.

Some playbook examples are provided in examples folder with information about how to built a test environment.

Below is a very basic example to build a container tology on a CloudVision platform assuming you have 3 veos named veos0{1,3} and a configlet named alias

---
- name: Playbook to demonstrate cv_container module.
  hosts: cvp
  connection: local
  gather_facts: no
  collections:
    - arista.cvp
  vars:
    containers_provision:
        Fabric:
          parent_container: Tenant
        Spines:
          parent_container: Fabric
        Leaves:
          parent_container: Fabric
          configlets:
              - alias
          devices:
            - veos03
        MLAG01:
          parent_container: Leaves
          devices:
            - veos01
            - veos02
  tasks:
    - name: "Gather CVP facts from {{inventory_hostname}}"
      cv_facts:
      register: cvp_facts

    - name: "Build Container topology on {{inventory_hostname}}"
      cv_container:
        topology: '{{containers_provision}}'
        cvp_facts: '{{cvp_facts.ansible_facts}}'
        save_topology: true

As modules of this collection are based on HTTPAPI connection plugin, authentication elements shall be declared using this plugin mechanism and are automatically shared with arista.cvp.cv_* modules.

[development]
cvp_foster  ansible_host= 10.90.224.122 ansible_httpapi_host=10.90.224.122

[development:vars]
ansible_connection=httpapi
ansible_httpapi_use_ssl=True
ansible_httpapi_validate_certs=False
ansible_user=cvpadmin
ansible_password=ansible
ansible_network_os=eos
ansible_httpapi_port=443

As modules of this collection are based on HTTPAPI connection plugin, authentication elements shall be declared using this plugin mechanism and are automatically shared with arista.cvp.cv_* modules.

• Ansible for Arista Validated Design
• Ansible EOS modules on ansible documentation.
• CloudVision Platform overvierw

Project is published under Apache License.

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

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.

A more complete guide for contribution is available in the repository