The Ansible VyOS collection includes a variety of Ansible content to help automate the management of VyOS network appliances.

This collection has been tested against VyOS 1.1.8 (helium).

This collection has been tested against following Ansible versions: >=2.9,<2.11.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

The VyOS collection supports network_cli connections.

Click the Content button to see the list of content included in this collection.

You can install the VyOS collection with the Ansible Galaxy CLI:

ansible-galaxy collection install vyos.vyos

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: vyos.vyos
    version: 0.0.2

This collection includes network resource modules.

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as vyos.vyos.vyos_static_routes. The following example task replaces configuration changes in the existing configuration on a VyOS network device, using the FQCN:

---
  - name: Replace device configurations of listed static routes with provided
      configurations
    register: result
    vyos.vyos.vyos_static_routes: &id001
      config:

        - address_families:

            - afi: ipv4
              routes:

                - dest: 192.0.2.32/28
                  blackhole_config:
                    distance: 2
                  next_hops:

                    - forward_router_address: 192.0.2.7

                    - forward_router_address: 192.0.2.8

                    - forward_router_address: 192.0.2.9
      state: replaced

Alternately, you can call modules by their short name if you list the vyos.vyos collection in the playbook's collections, as follows:

---
- hosts: vyos01
  gather_facts: false
  connection: network_cli

  collections:
    - vyos.vyos

  tasks:
    - name: Merge the provided configuration with the existing running configuration
      register: result
      vyos_l3_interfaces: &id001
        config:

          - name: eth1
            ipv4:

              - address: 192.0.2.10/24
            ipv6:

              - address: 2001:db8::10/32

          - name: eth2
            ipv4:

              - address: 198.51.100.10/24
            vifs:

              - vlan_id: 101
                ipv4:

                  - address: 198.51.100.130/25
                ipv6:

                  - address: 2001:db8::20/32
        state: merged

• VyOS Platform Options
• Ansible Using collections for more details.

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the VyOS collection repository.

You can also join us on:

• Freenode IRC - #ansible-network Freenode channel
• Slack - https://ansiblenetwork.slack.com

See the Ansible Community Guide for details on contributing to Ansible.

• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

GNU General Public License v3.0 or later.

See LICENSE to see the full text.