vyos_static_route - Manage static IP routes on Cisco VyOS network devices

New in version 2.4.

Synopsis

  • This module provides declarative management of static IP routes on Vyatta VyOS network devices.

Options

parameter required default choices comments
admin_distance
 no
Admin distance of the static route.
aggregate
 no
List of static route definitions
mask
 no
Network prefix mask of the static route.
next_hop
 no
Next hop IP of the static route.
prefix
 no
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
state
 no present
  • present
  • absent
State of the static route configuration.

Examples

- name: configure static route
  vyos_static_route:
    prefix: 192.168.2.0
    mask: 24
    next_hop: 10.0.0.1

- name: configure static route prefix/mask
  vyos_static_route:
    prefix: 192.168.2.0/16
    next_hop: 10.0.0.1

- name: remove configuration
  vyos_static_route:
    prefix: 192.168.2.0
    mask: 16
    next_hop: 10.0.0.1
    state: absent

- name: configure aggregates of static routes
  vyos_static_route:
    aggregate:
      - { prefix: 192.168.2.0, mask: 24, next_hop: 10.0.0.1 }
      - { prefix: 192.168.3.0, mask: 16, next_hop: 10.0.2.1 }
      - { prefix: 192.168.3.0/16, next_hop: 10.0.2.1 }

- name: Remove static route collections
  vyos_static_route:
    aggregate:
      - { prefix: 172.24.1.0/24, next_hop: 192.168.42.64 }
      - { prefix: 172.24.3.0/24, next_hop: 192.168.42.64 }
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
commands
The list of configuration mode commands to send to the device
 always list ['set protocols static route 192.168.2.0/16 next-hop 10.0.0.1']

Notes

Note

  • Tested against VYOS 1.1.7

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vyos_static_route_module.html