junipernetworks.junos.junos_static_routes module – Static routes resource module
Note
This module is part of the junipernetworks.junos collection (version 5.3.1).
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 junipernetworks.junos
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: junipernetworks.junos.junos_static_routes
.
New in junipernetworks.junos 1.0.0
Synopsis
This module provides declarative management of static routes on Juniper JUNOS devices
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ncclient (>=v0.6.4)
xmltodict (>=0.12)
Parameters
Parameter |
Comments |
---|---|
A dictionary of static routes options |
|
Address family to use for the static routes |
|
afi to use for the static routes Choices:
|
|
Static route configuration |
|
Static route destination including prefix |
|
Metric value for the static route |
|
Next hop to destination |
|
List of next hops |
|
Virtual Routing and Forwarding (VRF) name |
|
This option is used only with state parsed. The value of this option should be the output received from the Junos device by executing the command show routing-options. The state parsed reads the configuration from |
|
The state the configuration should be left in Choices:
|
Notes
Note
This module requires the netconf system service be enabled on the device being managed.
This module works with connection
netconf
. See the Junos OS Platform Options.Tested against JunOS v18.4R1
Examples
# Using deleted
# Before state
# ------------
#
# admin# show routing-options
# static {
# route 192.168.47.0/24 next-hop 172.16.1.2;
# route 192.168.16.0/24 next-hop 172.16.1.2;
# }
- name: Delete provided configuration (default operation is merge)
junipernetworks.junos.junos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 192.168.16.0/24
next_hop:
- forward_router_address: 172.16.1.2
state: deleted
# Task Output
# -----------
# before:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# commands:
# - '<nc:routing-options
# xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"><nc:static><nc:route
# delete="delete"><nc:name>192.168.16.0/24</nc:name></nc:route></nc:static></nc:routing-options>'
# - '<nc:routing-instances xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"/>'
# after:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# After state:
# ------------
#
# admin# show routing-options
# static {
# route 192.168.47.0/24 next-hop 172.16.1.2;
# }
# Using merged
# Before state
# ------------
#
# admin# show routing-options
# static {
# route 192.168.47.0/24 next-hop 172.16.1.2;
# }
- name: Merge provided configuration with device configuration (default operation
is merge)
junipernetworks.junos.junos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 192.168.16.0/24
next_hop:
- forward_router_address: 172.16.1.2
state: merged
# Task Output
# -----------
# before:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# commands:
# - '<nc:routing-options
# xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"><nc:static><nc:route><nc:name>192.168.16.0/24</nc:name>
# <nc:next-hop>172.16.1.2</nc:next-hop></nc:route></nc:static></nc:routing-options>'
# - '<nc:routing-instances xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"/>'
# after:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# After state:
# ------------
#
# admin# show routing-options
# static {
# route 192.168.47.0/24 next-hop 172.16.1.2;
# route 192.168.16.0/24 next-hop 172.16.1.2;
# }
# Using overridden
# Before state
# ------------
#
# admin# show routing-options
# static {
# route 192.168.47.0/24 next-hop 172.16.1.2;
# route 192.168.16.0/24 next-hop 172.16.1.2;
# }
- name: Override running configuration with provided configuration (default operation
is merge)
junipernetworks.junos.junos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 192.168.16.0/24
next_hop:
- forward_router_address: 172.16.0.1
state: overridden
# Task Output:
# ------------
# before:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# commands:
# - >-
# <nc:routing-options
# xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"><nc:static><nc:route
# delete="delete"><nc:name>192.168.47.0/24</nc:name></nc:route><nc:route
# delete="delete"><nc:name>192.168.16.0/24</nc:name></nc:route></nc:static><nc:static><nc:route><nc:name>192.168.16.0/24</nc:name><nc:next-hop>172.16.0.1</nc:next-hop></nc:route></nc:static></nc:routing-options>
# - '<nc:routing-instances xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"/>'
# after:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: 172.16.0.1
# After state:
# ------------
#
# admin# show routing-options
# static {
# route 192.168.16.0/24 next-hop 172.16.0.1;
# }
# Using replaced
# Before state
# ------------
#
# admin# show routing-options
# static {
# route 192.168.47.0/24 next-hop 172.16.1.2;
# route 192.168.16.0/24 next-hop 172.16.1.2;
# }
- name: Replace provided configuration with device configuration (default operation
is merge)
junipernetworks.junos.junos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 192.168.47.0/24
next_hop:
- forward_router_address: 10.200.16.2
state: replaced
# Task Output:
# ------------
# before:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# commands:
# - >-
# <nc:routing-options
# xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"><nc:static><nc:route
# delete="delete"><nc:name>192.168.47.0/24</nc:name></nc:route></nc:static><nc:static><nc:route><nc:name>192.168.47.0/24</nc:name><nc:next-hop>10.200.16.2</nc:next-hop></nc:route></nc:static></nc:routing-options>
# - '<nc:routing-instances xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"/>'
# after:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 10.200.16.2
# After state:
# ------------
#
# admin# show routing-options
# static {
# route 192.168.47.0/24 next-hop 10.200.16.2;
# route 192.168.16.0/24 next-hop 172.16.1.2;
# }
# Using gathered to gather static route facts from the device
# Before state
# ------------
# admin# show routing-options
# static {
# route 192.168.16.0/24 next-hop 172.16.1.2;
# route 192.168.47.0/24 next-hop 10.200.16.2;
# }
- name: Gather static routes facts from the device using junos_static_routes module
junipernetworks.junos.junos_static_routes:
state: gathered
# Task output:
# ------------
# gathered:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: 172.16.1.2
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 10.200.16.2
# Using rendered
- name: Render platform specific commands (without connecting to the device)
junipernetworks.junos.junos_static_routes:
config:
- address_families:
- afi: ipv4
routes:
- dest: 192.168.16.0/24
next_hop:
- forward_router_address: 172.16.1.2
state: rendered
# Task output:
# ------------
# rendered:
# - '<nc:routing-options
# xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"><nc:static><nc:route><nc:name>192.168.16.0/24</nc:name>
# <nc:next-hop>172.16.1.2</nc:next-hop></nc:route></nc:static></nc:routing-options>'
# Using parsed
# parsed.cfg
# ------------
# <?xml version="1.0" encoding="UTF-8"?>
# <rpc-reply message-id="urn:uuid:0cadb4e8-5bba-47f4-986e-72906227007f">
# <configuration changed-seconds="1590139550" changed-localtime="2020-05-22 09:25:50 UTC">
# <version>18.4R1-S2.4</version>
# <routing-options>
# <static>
# <route>
# <name>192.168.16.0/24</name>
# <next-hop>172.16.1.2</next-hop>
# <next-hop>172.16.1.3</next-hop>
# </route>
# <route>
# <name>192.168.47.0/24</name>
# <next-hop>10.200.16.2</next-hop>
# </route>
# </static>
# </routing-options>
# </configuration>
# </rpc-reply>
- name: Parsed running config (without connecting to the device)
junipernetworks.junos.junos_static_routes:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# Task output:
# ------------
# parsed:
# - address_families:
# - afi: ipv4
# routes:
# - dest: 192.168.16.0/24
# next_hop:
# - forward_router_address: '[''172.16.1.2'', ''172.16.1.3'']'
# - dest: 192.168.47.0/24
# next_hop:
# - forward_router_address: 10.200.16.2
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: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is Sample: |