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.10.
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.
Name | Description |
---|---|
vyos.vyos.vyos | Use vyos cliconf to run command on VyOS platform |
Name | Description |
---|---|
vyos.vyos.vyos_banner | Manage multiline banners on VyOS devices |
vyos.vyos.vyos_bgp_address_family | BGP Address Family Resource Module. |
vyos.vyos.vyos_bgp_global | BGP Global Resource Module. |
vyos.vyos.vyos_command | Run one or more commands on VyOS devices |
vyos.vyos.vyos_config | Manage VyOS configuration on remote device |
vyos.vyos.vyos_facts | Get facts about vyos devices. |
vyos.vyos.vyos_firewall_global | FIREWALL global resource module |
vyos.vyos.vyos_firewall_interfaces | FIREWALL interfaces resource module |
vyos.vyos.vyos_firewall_rules | FIREWALL rules resource module |
vyos.vyos.vyos_hostname | Manages hostname resource module |
vyos.vyos.vyos_interface | (deprecated, removed after 2022-06-01) Manage Interface on VyOS network devices |
vyos.vyos.vyos_interfaces | Interfaces resource module |
vyos.vyos.vyos_l3_interface | (deprecated, removed after 2022-06-01) Manage L3 interfaces on VyOS network devices |
vyos.vyos.vyos_l3_interfaces | L3 interfaces resource module |
vyos.vyos.vyos_lag_interfaces | LAG interfaces resource module |
vyos.vyos.vyos_linkagg | (deprecated, removed after 2022-06-01) Manage link aggregation groups on VyOS network devices |
vyos.vyos.vyos_lldp | (deprecated, removed after 2022-06-01) Manage LLDP configuration on VyOS network devices |
vyos.vyos.vyos_lldp_global | LLDP global resource module |
vyos.vyos.vyos_lldp_interface | (deprecated, removed after 2022-06-01) Manage LLDP interfaces configuration on VyOS network devices |
vyos.vyos.vyos_lldp_interfaces | LLDP interfaces resource module |
vyos.vyos.vyos_logging | Manage logging on network devices |
vyos.vyos.vyos_logging_global | Logging resource module |
vyos.vyos.vyos_ntp_global | Manages ntp modules of Vyos network devices |
vyos.vyos.vyos_ospf_interfaces | OSPF Interfaces Resource Module. |
vyos.vyos.vyos_ospfv2 | OSPFv2 resource module |
vyos.vyos.vyos_ospfv3 | OSPFV3 resource module |
vyos.vyos.vyos_ping | Tests reachability using ping from VyOS network devices |
vyos.vyos.vyos_prefix_lists | Prefix-Lists resource module for VyOS |
vyos.vyos.vyos_route_maps | Route Map Resource Module. |
vyos.vyos.vyos_snmp_server | Manages snmp_server resource module |
vyos.vyos.vyos_static_route | (deprecated, removed after 2022-06-01) Manage static IP routes on Vyatta VyOS network devices |
vyos.vyos.vyos_static_routes | Static routes resource module |
vyos.vyos.vyos_system | Run set system commands on VyOS devices |
vyos.vyos.vyos_user | Manage the collection of local users on VyOS device |
vyos.vyos.vyos_vlan | Manage VLANs on VyOS network devices |
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
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
NOTE: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.
- 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. See Contributing to Ansible-maintained collections for complete details.
You can also join us on:
- IRC - the
#ansible-network
irc.libera.chat channel - Slack - https://ansiblenetwork.slack.com
See the Ansible Community Guide for details on contributing to Ansible.
This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.
Release notes are available here.
- 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.