cisco.nxos.nxos_static_routes – Static routes resource module
Note
This plugin is part of the cisco.nxos collection (version 1.3.1).
To install it use: ansible-galaxy collection install cisco.nxos.
To use it in a playbook, specify: cisco.nxos.nxos_static_routes.
New in version 1.0.0: of cisco.nxos
Synopsis
- This module configures and manages the attributes of static routes on Cisco NX-OS platforms.
Note
This module has a corresponding action plugin.
Parameters
| Parameter | Choices/Defaults | Comments | ||||
|---|---|---|---|---|---|---|
| config
list / elements=dictionary
|
A list of configurations for static routes
|
|||||
| address_families
list / elements=dictionary
|
A dictionary specifying the address family to which the static route(s) belong.
|
|||||
| afi
string / required
|
|
Specifies the top level address family indicator.
|
||||
| routes
list / elements=dictionary
|
A dictionary that specifies the static route configurations
|
|||||
| dest
string / required
|
Destination prefix of static route
The address format is <ipv4/v6 address>/<mask>
The mask is number in range 0-32 for IPv4 and in range 0-128 for IPv6
|
|||||
| next_hops
list / elements=dictionary
|
Details of route to be taken
|
|||||
| admin_distance
integer
|
Preference or administrative distance of route (range 1-255)
|
|||||
| dest_vrf
string
|
VRF of the destination
|
|||||
| forward_router_address
string
|
IP address of the next hop router
|
|||||
| interface
string
|
Outgoing interface to take. For anything except 'Null0', then next hop IP address should also be configured.
|
|||||
| route_name
string
|
Name of the static route
|
|||||
| tag
integer
|
Route tag value (numeric)
|
|||||
| track
integer
|
Track value (range 1 - 512). Track must already be configured on the device before adding the route.
|
|||||
| vrf
string
|
The VRF to which the static route(s) belong
|
|||||
| running_config
string
|
This option is used only with state parsed.
The value of this option should be the output received from the NX-OS device by executing the following commands in order show running-config | include '^ip(v6* route') and show running-config | section '^vrf context'.
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
|
|||||
| state
string
|
|
The state the configuration should be left in
|
||||
Notes
Note
- Tested against NX-OS 7.3.(0)D1(1) on VIRL
- When a route is configured for a non-existent VRF, the VRF is created and the route is added to it.
- When deleting routes for a VRF, all routes inside the VRF are deleted, but the VRF is not deleted.
Examples
# Using deleted:
# Before state:
# -------------
#
# ip route 192.0.2.32/28 192.0.2.12 name new_route
# ip route 192.0.2.26/24 192.0.2.13 tag 12
- name: Delete all routes
cisco.nxos.nxos_static_routes:
state: deleted
# After state:
# ------------
#
# Before state:
# ------------
#
# ip route 192.0.2.16/28 192.0.2.24 name new_route
# ip route 192.0.2.80/28 192.0.2.26 tag 12
# vrf context trial_vrf
# ip route 192.0.2.64/28 192.0.2.22 tag 4
# ip route 192.0.2.64/28 192.0.2.23 name merged_route 1
# ipv6 route 2200:10::/36 2048:ae12::1 vrf dest 5
- name: Delete routes based on VRF
cisco.nxos.nxos_static_routes:
config:
- vrf: trial_vrf
state: deleted
# After state:
# -----------
# ip route 192.0.2.16/28 192.0.2.24 name new_route
# ip route 192.0.2.80/28 192.0.2.26 tag 12
# vrf context trial_vrf
# Before state:
# ------------
#
# ip route 192.0.2.16/28 192.0.2.24 name new_route
# ip route 192.0.2.80/28 192.0.2.26 tag 12
# vrf context trial_vrf
# ip route 192.0.2.64/28 192.0.2.22 tag 4
# ip route 192.0.2.64/28 192.0.2.23 name merged_route 1
# ipv6 route 2200:10::/36 2048:ae12::1 vrf dest 5
- name: Delete routes based on AFI in a VRF
cisco.nxos.nxos_static_routes:
config:
- vrf: trial_vrf
address_families:
- afi: ipv4
state: deleted
# After state:
# -----------
# ip route 192.0.2.16/28 192.0.2.24 name new_route
# ip route 192.0.2.80/28 192.0.2.26 tag 12
# vrf context trial_vrf
# ipv6 route 2200:10::/36 2048:ae12::1 vrf dest 5
# Before state:
# -----------
# ip route 192.0.2.16/28 192.0.2.24 name new_route
# vrf context trial_vrf
# ipv6 route 2200:10::/36 2048:ae12::1 vrf dest 5
# Using merged
# Before state:
# -------------
#
- name: Merge new static route configuration
cisco.nxos.nxos_static_routes:
config:
- vrf: trial_vrf
address_families:
- afi: ipv4
routes:
- dest: 192.0.2.64/24
next_hops:
- forward_router_address: 192.0.2.22
tag: 4
admin_distance: 2
- address_families:
- afi: ipv4
routes:
- dest: 192.0.2.16/24
next_hops:
- forward_router_address: 192.0.2.24
route_name: new_route
- afi: ipv6
routes:
- dest: 2001:db8::/64
next_hops:
- interface: eth1/3
forward_router_address: 2001:db8::12
state: merged
# After state:
# ------------
#
# ip route 192.0.2.16/24 192.0.2.24 name new_route
# ipv6 route 2001:db8::/64 Ethernet1/3 2001:db8::12
# vrf context trial_vrf
# ip route 192.0.2.0/24 192.0.2.22 tag 4 2
# Using overridden:
# Before state:
# -------------
#
# ip route 192.0.2.16/28 192.0.2.24 name new_route
# ip route 192.0.2.80/28 192.0.2.26 tag 12
# vrf context trial_vrf
# ip route 192.0.2.64/28 192.0.2.22 tag 4
# ip route 192.0.2.64/28 192.0.2.23 name merged_route 1
- name: Overriden existing static route configuration with new configuration
cisco.nxos.nxos_static_routes:
config:
- vrf: trial_vrf
address_families:
- afi: ipv4
routes:
- dest: 192.0.2.16/28
next_hops:
- forward_router_address: 192.0.2.23
route_name: overridden_route1
admin_distance: 3
- forward_router_address: 192.0.2.45
route_name: overridden_route2
dest_vrf: destinationVRF
interface: Ethernet1/2
state: overridden
# After state:
# ------------
#
# ip route 192.0.2.16/28 192.0.2.23 name replaced_route1 3
# ip route 192.0.2.16/28 Ethernet1/2 192.0.2.45 vrf destinationVRF name replaced_route2
# Using replaced:
# Before state:
# ------------
# ip route 192.0.2.16/28 192.0.2.24 name new_route
# ip route 192.0.2.80/28 192.0.2.26 tag 12
# vrf context trial_vrf
# ip route 192.0.2.64/28 192.0.2.22 tag 4
# ip route 192.0.2.64/28 192.0.2.23 name merged_route 1
- name: Replaced the existing static configuration of a prefix with new configuration
cisco.nxos.nxos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 192.0.2.16/28
next_hops:
- forward_router_address: 192.0.2.23
route_name: replaced_route1
admin_distance: 3
- forward_router_address: 192.0.2.45
route_name: replaced_route2
dest_vrf: destinationVRF
interface: Ethernet1/2
state: replaced
# After state:
# -----------
# ip route 192.0.2.16/28 192.0.2.23 name replaced_route1 3
# ip route 192.0.2.16/28 Ethernet1/2 192.0.2.45 vrf destinationVRF name replaced_route2
# ip route 192.0.2.80/28 192.0.2.26 tag 12
# vrf context trial_vrf
# ip route 192.0.2.64/28 192.0.2.22 tag 4
# ip route 192.0.2.64/28 192.0.2.23 name merged_route 1
# Using gathered:
# Before state:
# -------------
# ipv6 route 2001:db8:12::/32 2001:db8::12
# vrf context Test
# ip route 192.0.2.48/28 192.0.2.13
# ip route 192.0.2.48/28 192.0.2.14 5
- name: Gather the exisitng condiguration
cisco.nxos.nxos_static_routes:
state: gathered
# returns:
# gathered:
# - vrf: Test
# address_families:
# - afi: ipv4
# routes:
# - dest: 192.0.2.48/28
# next_hops:
# - forward_router_address: 192.0.2.13
#
# - forward_router_address: 192.0.2.14
# admin_distance: 5
#
# - address_families:
# - afi: ipv6
# routes:
# - dest: 2001:db8:12::/32
# next_hops:
# - forward_router_address: 2001:db8::12
# Using rendered:
- name: Render required configuration to be pushed to the device
cisco.nxos.nxos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 192.0.2.48/28
next_hops:
- forward_router_address: 192.0.2.13
- afi: ipv6
routes:
- dest: 2001:db8::/64
next_hops:
- interface: eth1/3
forward_router_address: 2001:db8::12
state: rendered
# returns
# rendered:
# vrf context default
# ip route 192.0.2.48/28 192.0.2.13
# ipv6 route 2001:db8::/64 Ethernet1/3 2001:db8::12
# Using parsed
- name: Parse the config to structured data
cisco.nxos.nxos_static_routes:
running_config: |
ipv6 route 2002:db8:12::/32 2002:db8:12::1
vrf context Test
ip route 192.0.2.48/28 192.0.2.13
ip route 192.0.2.48/28 192.0.2.14 5
# returns:
# parsed:
# - vrf: Test
# address_families:
# - afi: ipv4
# routes:
# - dest: 192.0.2.48/28
# next_hops:
# - forward_router_address: 192.0.2.13
#
# - forward_router_address: 192.0.2.14
# admin_distance: 5
#
# - address_families:
# - afi: ipv6
# routes:
# - dest: 2002:db8:12::/32
# next_hops:
# - forward_router_address: 2002:db8:12::1
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| after
list / elements=string
|
when changed |
The resulting configuration model invocation.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
| before
list / elements=string
|
always |
The configuration prior to the model invocation.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
| commands
list / elements=string
|
always |
The set of commands pushed to the remote device.
Sample:
['ip route 192.0.2.48/28 192.0.2.12 Ethernet1/2 name sample_route', 'ipv6 route 2001:db8:3000::/36 2001:db8:200:2::2', 'vrf context test', 'ip route 192.0.2.48/28 192.0.2.121']
|
Authors
- Adharsh Srivats Rangarajan (@adharshsrivatsr)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_static_routes_module.html