arista.eos.eos_static_routes module – Static routes resource module
Note
This module is part of the arista.eos collection (version 9.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install arista.eos.
To use it in a playbook, specify: arista.eos.eos_static_routes.
New in arista.eos 1.0.0
Synopsis
This module configures and manages the attributes of static routes on Arista EOS platforms.
Aliases: static_routes
Parameters
Parameter |
Comments |
|---|---|
A list of configurations for static routes. |
|
A dictionary specifying the address family to which the static route(s) belong. |
|
Specifies the top level address family indicator. Choices:
|
|
A dictionary that specifies the static route configurations. |
|
Destination IPv4 subnet (CIDR or address-mask notation). The address format is <v4/v6 address>/<mask> or <v4/v6 address> <mask>. The mask is number in range 0-32 for IPv4 and in range 0-128 for IPv6. |
|
Details of route to be taken. |
|
Preference or administrative distance of route (range 1-255). |
|
Name of the static route. |
|
Forwarding router’s address on destination interface. |
|
Outgoing interface to take. For anything except ‘null0’, then next hop IP address should also be configured. IP address of the next hop router or null0 Null0 interface or ethernet e_num Ethernet interface or loopback l_num Loopback interface or management m_num Management interface or port-channel p_num vlan v_num vxlan vx_num Nexthop-Group Specify nexthop group name Tunnel Tunnel interface vtep Configure VXLAN Tunnel End Points |
|
MPLS label |
|
Nexthop group |
|
Route tag value (ranges from 0 to 4294967295). |
|
Track value (range 1 - 512). Track must already be configured on the device before adding the route. |
|
VRF of the destination. |
|
The VRF to which the static route(s) belong. |
|
This option is used only with state parsed. The value of this option should be the output received from the EOS device by executing the command show running-config | grep routes. The state parsed reads the configuration from |
|
The state the configuration should be left in. Choices:
|
Notes
Note
Tested against Arista EOS 4.24.6F
This module works with connection
network_cli. See the EOS Platform Options.
Examples
# Using deleted
# Before State:
# ------------
# veos(config)#show running-config | grep route
# ip route vrf testvrf 22.65.1.0/24 Null0 90 name testroute
# ipv6 route 5222:5::/64 Management1 4312:100::1
# ipv6 route vrf testvrf 2222:6::/64 Management1 4312:100::1
# ipv6 route vrf testvrf 2222:6::/64 Ethernet1 55
# ipv6 route vrf testvrf 2222:6::/64 Null0 90 name testroute1
# veos(config)#
- name: Delete afi
arista.eos.eos_static_routes:
config:
- vrf: testvrf
address_families:
- afi: ipv4
state: deleted
# Task Output
# -------------
# before:
# - address_families:
# - afi: ipv6
# routes:
# - dest: 5222:5::/64
# next_hops:
# - forward_router_address: 4312:100::1
# interface: Management1
# - address_families:
# - afi: ipv4
# routes:
# - dest: 22.65.1.0/24
# next_hops:
# - admin_distance: 90
# description: testroute
# interface: Null0
# - afi: ipv6
# routes:
# - dest: 2222:6::/64
# next_hops:
# - forward_router_address: 4312:100::1
# interface: Management1
# - admin_distance: 55
# interface: Ethernet1
# - admin_distance: 90
# description: testroute1
# interface: Null0
# vrf: testvrf
# commands:
# - no ip route vrf testvrf 22.65.1.0/24 Null0 90 name testroute
# after:
# - address_families:
# - afi: ipv6
# routes:
# - dest: 5222:5::/64
# next_hops:
# - forward_router_address: 4312:100::1
# interface: Management1
# - address_families:
# - afi: ipv6
# routes:
# - dest: 2222:6::/64
# next_hops:
# - forward_router_address: 4312:100::1
# interface: Management1
# - admin_distance: 55
# interface: Ethernet1
# - admin_distance: 90
# description: testroute1
# interface: Null0
# vrf: testvrf
# After State
# ___________
# veos(config)#show running-config | grep route
# ipv6 route 5222:5::/64 Management1 4312:100::1
# ipv6 route vrf testvrf 2222:6::/64 Management1 4312:100::1
# ipv6 route vrf testvrf 2222:6::/64 Ethernet1 55
# ipv6 route vrf testvrf 2222:6::/64 Null0 90 name testroute1
# Using merged
# Before State
# -------------
# veos(config)#show running-config | grep "route"
# ip route 165.10.1.0/24 Ethernet1 100
# ip route 172.17.252.0/24 Nexthop-Group testgroup
# ip route vrf testvrf 130.1.122.0/24 Ethernet1 tag 50
# ipv6 route 5001::/64 Ethernet1 50
# veos(config)#
- name: Merge new static route configuration
arista.eos.eos_static_routes:
config:
- vrf: testvrf
address_families:
- afi: ipv6
routes:
- dest: 2211::0/64
next_hop:
- forward_router_address: 100:1::2
interface: Ethernet1
state: merged
# Task Output
# -------------
# before:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 165.10.1.0/24
# next_hops:
# - admin_distance: 100
# interface: Ethernet1
# - dest: 172.17.252.0/24
# next_hops:
# - nexthop_grp: testgroup
# - afi: ipv6
# routes:
# - dest: 5001::/64
# next_hops:
# - admin_distance: 50
# interface: Ethernet1
# - address_families:
# - afi: ipv4
# routes:
# - dest: 130.1.122.0/24
# next_hops:
# - interface: Ethernet1
# tag: 50
# vrf: testvrf
# commands:
# - ipv6 route 2211::/64 Ethernet1 100:1::2
# after:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 165.10.1.0/24
# next_hops:
# - admin_distance: 100
# interface: Ethernet1
# - dest: 172.17.252.0/24
# next_hops:
# - nexthop_grp: testgroup
# - afi: ipv6
# routes:
# - dest: 5001::/64
# next_hops:
# - admin_distance: 50
# interface: Ethernet1
# - address_families:
# - afi: ipv4
# routes:
# - dest: 130.1.122.0/24
# next_hops:
# - interface: Ethernet1
# tag: 50
# - afi: ipv6
# routes:
# - dest: 2211::0/64
# next_hops:
# - aforward_router_address: "100:1::2"
# interface: Ethernet1
# vrf: testvrf
# After State
# -----------
# veos(config)#show running-config | grep "route"
# ip route 165.10.1.0/24 Ethernet1 100
# ip route 172.17.252.0/24 Nexthop-Group testgroup
# ip route vrf testvrf 130.1.122.0/24 Ethernet1 tag 50
# ipv6 route 2211::/64 Ethernet1 100:1::2
# ipv6 route 5001::/64 Ethernet1 50
# veos(config)#
# Using overridden
# Before State
# -------------
# veos(config)#show running-config | grep "route"
# ip route 165.10.1.0/24 Ethernet1 100
# ip route 172.17.252.0/24 Nexthop-Group testgroup
# ip route vrf testvrf 130.1.122.0/24 Ethernet1 tag 50
# ipv6 route 5001::/64 Ethernet1 50
# veos(config)#
- name: Overridden static route configuration
arista.eos.eos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 10.2.2.0/24
next_hop:
- interface: Ethernet1
state: replaced
# Task Output
# -------------
# before:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 165.10.1.0/24
# next_hops:
# - admin_distance: 100
# interface: Ethernet1
# - dest: 172.17.252.0/24
# next_hops:
# - nexthop_grp: testgroup
# - afi: ipv6
# routes:
# - dest: 5001::/64
# next_hops:
# - admin_distance: 50
# interface: Ethernet1
# - address_families:
# - afi: ipv4
# routes:
# - dest: 130.1.122.0/24
# next_hops:
# - interface: Ethernet1
# tag: 50
# vrf: testvrf
# commands:
# - no ip route 165.10.1.0/24 Ethernet1 100
# - no ip route 172.17.252.0/24 Nexthop-Group testgroup
# - no ip route vrf testvrf 130.1.122.0/24 Ethernet1 tag 50
# - no ipv6 route 5001::/64 Ethernet1 50
# - ip route 10.2.2.0/24 Ethernet1
# after:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 10.2.2.0/24
# next_hops:
# - interface: Ethernet1
# After State
# -----------
# veos(config)#show running-config | grep "route"
# ip route 10.2.2.0/24 Ethernet1
# veos(config)#
# Using replaced
# Before State
# -------------
# ip route 10.2.2.0/24 Ethernet1
# ip route 10.2.2.0/24 64.1.1.1 label 17 33
# ip route 33.33.33.0/24 Nexthop-Group testgrp
# ip route vrf testvrf 22.65.1.0/24 Null0 90 name testroute
# ipv6 route 5222:5::/64 Management1 4312:100::1
# ipv6 route vrf testvrf 2222:6::/64 Management1 4312:100::1
# ipv6 route vrf testvrf 2222:6::/64 Ethernet1 55
# ipv6 route vrf testvrf 2222:6::/64 Null0 90 name testroute1
- name: Replace nexthop
arista.eos.eos_static_routes:
config:
- vrf: testvrf
address_families:
- afi: ipv6
routes:
- dest: 2222:6::/64
next_hops:
- admin_distance: 56
interface: Ethernet1
state: replaced
# Task Output
# -------------
# before:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 10.2.2.0/24
# next_hops:
# - interface: Ethernet1
# - admin_distance: 33
# interface: 64.1.1.1
# mpls_label: 17
# - dest: 33.33.33.0/24
# next_hops:
# - nexthop_grp: testgrp
# - afi: ipv6
# routes:
# - dest: 5222:5::/64
# next_hops:
# - forward_router_address: 4312:100::1
# interface: Management1
# - address_families:
# - afi: ipv4
# routes:
# - dest: 22.65.1.0/24
# next_hops:
# - admin_distance: 90
# description: testroute
# interface: Null0
# - afi: ipv6
# routes:
# - dest: 2222:6::/64
# next_hops:
# - forward_router_address: 4312:100::1
# interface: Management1
# - admin_distance: 90
# description: testroute1
# interface: Null0
# vrf: testvrf
# commands:
# - no ipv6 route vrf testvrf 2222:6::/64 Management1 4312:100::1
# - no ipv6 route vrf testvrf 2222:6::/64 Ethernet1 55
# - no ipv6 route vrf testvrf 2222:6::/64 Null0 90 name testroute1
# - ipv6 route vrf testvrf 2222:6::/64 Ethernet1 56
# after:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 10.2.2.0/24
# next_hops:
# - interface: Ethernet1
# - admin_distance: 33
# interface: 64.1.1.1
# mpls_label: 17
# - dest: 33.33.33.0/24
# next_hops:
# - nexthop_grp: testgrp
# - afi: ipv6
# routes:
# - dest: 5222:5::/64
# next_hops:
# - forward_router_address: 4312:100::1
# interface: Management1
# - address_families:
# - afi: ipv4
# routes:
# - dest: 22.65.1.0/24
# next_hops:
# - admin_distance: 90
# description: testroute
# interface: Null0
# - afi: ipv6
# routes:
# - dest: 2222:6::/64
# next_hops:
# - admin_distance: 56
# interface: Ethernet1
# vrf: testvrf
# After State
# -----------
# veos(config)#show running-config | grep route
# ip route 10.2.2.0/24 Ethernet1
# ip route 10.2.2.0/24 64.1.1.1 label 17 33
# ip route 33.33.33.0/24 Nexthop-Group testgrp
# ip route vrf testvrf 22.65.1.0/24 Null0 90 name testroute
# ipv6 route 5222:5::/64 Management1 4312:100::1
# ipv6 route vrf testvrf 2222:6::/64 Ethernet1 55
# Using Gathered
# Before State
# -------------
# veos(config)#show running-config | grep "route"
# ip route 165.10.1.0/24 Ethernet1 10.1.1.2 100
# ipv6 route 5001::/64 Ethernet1
# veos(config)#
- name: Gather the exisitng condiguration
arista.eos.eos_static_routes:
state: gathered
# Task Output
# -------------
# gathered:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 165.10.1.0/24
# next_hop:
# - forward_router_address: 10.1.1.2
# interface: Ethernet1
# admin_distance: 100
# - afi: ipv6
# routes:
# - dest: 5001::/64
# next_hop:
# - interface: Ethernet1
# Using rendered
# arista.eos.eos_static_routes:
# config:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 165.10.1.0/24
# next_hop:
# - forward_router_address: 10.1.1.2
# interface: "Ethernet1"
# admin_distance: 100
# - afi: ipv6
# routes:
# - dest: 5001::/64
# next_hop:
# - interface: "Ethernet1"
# Task Output
# -------------
# rendered:
# - ip route 165.10.1.0/24 Ethernet1 10.1.1.2 100
# - ipv6 route 5001::/64 Ethernet1
# Using parsed:
# parse_static_routes.cfg
# ip route 165.10.1.0/24 Ethernet1 10.1.1.2 100
# ipv6 route 5001::/64 Ethernet1
#
- name: parse configs
arista.eos.eos_static_routes:
running_config: "{{ lookup('file', './parse_static_routes.cfg') }}"
state: parsed
# Task Output
# -------------
# parsed:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 165.10.1.0/24
# next_hop:
# - forward_router_address: 10.1.1.2
# interface: Ethernet1
# admin_distance: 100
# - afi: ipv6
# routes:
# - dest: 5001::/64
# next_hop:
# - interface: Ethernet1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration model invocation. Returned: when changed Sample: |
|
The configuration prior to the model invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |
|
The configuration as structured data transformed for the running configuration fetched from remote host Returned: When Sample: |
|
The configuration as structured data transformed for the value of Returned: When Sample: |
|
The set of CLI commands generated from the value in Returned: When Sample: |