junipernetworks.junos.junos_routing_options module – Manage routing-options configuration on Junos devices.
Note
This module is part of the junipernetworks.junos collection (version 9.1.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 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_routing_options
.
New in junipernetworks.junos 2.8.0
Synopsis
This module manages routing-options configuration on devices running Junos.
Requirements
The below requirements are needed on the host that executes this module.
ncclient (>=v0.6.4)
xmltodict (>=0.12.0)
Parameters
Parameter |
Comments |
---|---|
A dictionary of routing-options configuration. |
|
Specify Autonomous system number. |
|
Specify Autonomous system number. |
|
Enable AS-Dot notation to display true 4 byte AS numbers. Choices:
|
|
Specify maximum number of times this AS can be in an AS path. |
|
Specify Router identifier. |
|
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 system routing-options. The state parsed reads the configuration from |
|
The state the configuration should be left in. Refer to examples for more details. Choices:
|
Notes
Note
This module requires the netconf system service be enabled on the device being managed.
This module works with connection
netconf
.Tested against JunOS v18.4R1
Examples
# Using merged
#
# Before state
# ------------
#
# vagrant@vsrx# show system routing-options
#
- name: Merge provided NTP configuration into running configuration.
junipernetworks.junos.junos_routing_options:
config:
autonomous_system:
as_number: 2
asdot_notation: true
state: merged
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true
# }
# },
# "before": {},
# "changed": true,
# "commands": [
# "<nc:routing-options xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">"
# "<nc:autonomous-system>2<nc:asdot-notation/></nc:autonomous-system></nc:routing-options>"
# ]
# After state
# -----------
#
# vagrant@vsrx# show routing-options
# autonomous-system 2 asdot-notation;
#
#
# Using Replaced
# Before state
# ------------
#
# vagrant@vsrx# show routing-options
# autonomous-system 2 asdot-notation;
- name: Replaced running routing-options configuration with provided configuration
junipernetworks.junos.junos_routing_options:
config:
autonomous_system:
as_number: 2
asdot_notation: true
router_id: "1.1.1.1"
state: replaced
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true
# },
# "router_id": "1.1.1.1"
# },
# "before": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true
# }
# },
# "changed": true,
# "commands": [
# "<nc:routing-options xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">"
# "<nc:autonomous-system delete="delete"/><nc:autonomous-system>2<nc:asdot-notation/>"
# "</nc:autonomous-system><nc:router-id>1.1.1.1</nc:router-id></nc:routing-options>"
# ]
# After state
# -----------
#
# vagrant@vsrx# show routing-options
# router-id 1.1.1.1;
# autonomous-system 2 asdot-notation;
# Using overridden
#
# vagrant@vsrx# show routing-options
# autonomous-system 2 asdot-notation;
- name: Override running routing-options configuration with provided configuration
junipernetworks.junos.junos_routing_options:
config:
autonomous_system:
as_number: 2
asdot_notation: true
router_id: "1.1.1.1"
state: overridden
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true
# },
# "router_id": "1.1.1.1"
# },
# "before": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true
# }
# },
# "changed": true,
# "commands": [
# "<nc:routing-options xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">"
# "<nc:autonomous-system delete="delete"/><nc:autonomous-system>2<nc:asdot-notation/>"
# "</nc:autonomous-system><nc:router-id>1.1.1.1</nc:router-id></nc:routing-options>"
# ]
# After state
# -----------
#
# vagrant@vsrx# show routing-options
# router-id 1.1.1.1;
# autonomous-system 2 asdot-notation;
#
# Using deleted
#
# Before state
# ------------
#
# vagrant@vsrx# show routing-options
# router-id 1.1.1.1;
# autonomous-system 2 asdot-notation;
#
- name: Delete running routing-options configuration
junipernetworks.junos.junos_routing_options:
config:
state: deleted
#
# -------------------------
# Module Execution Result
# -------------------------
# "after": {},
# "before": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true
# },
# "router_id": "1.1.1.1"
# },
# "changed": true,
# "commands": [
# "<nc:routing-options xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">"
# "<nc:autonomous-system delete="delete"/><nc:router-id delete="delete"/></nc:routing-options>"
# ]
# After state
# -----------
#
# vagrant@vsrx# show routing-options
#
# [edit]
# Using gathered
#
# Before state
# ------------
#
# vagrant@vsrx# show routing-options
# router-id 1.1.1.1;
# autonomous-system 2 asdot-notation;
- name: Gather running routing-options configuration
junipernetworks.junos.junos_routing_options:
state: gathered
#
# -------------------------
# Module Execution Result
# -------------------------
# "gathered": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true
# },
# "router_id": "1.1.1.1"
# },
# "changed": false,
# Using rendered
#
# Before state
# ------------
#
- name: Render xml for provided facts.
junipernetworks.junos.junos_routing_options:
config:
autonomous_system:
as_number: 2
asdot_notation: true
loops: 4
router_id: 12.12.12.12
state: rendered
#
# -------------------------
# Module Execution Result
# -------------------------
# "rendered": [
# "<nc:routing-options xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# "<nc:autonomous-system>2<nc:loops>4</nc:loops><nc:asdot-notation/></nc:autonomous-system>
# "<nc:router-id>12.12.12.12</nc:router-id></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>
# <router-id>12.12.12.12</router-id>
# <autonomous-system>
# <as-number>2</as-number>
# <loops>4</loops>
# <asdot-notation/>
# </autonomous-system>
# </routing-options>
# </configuration>
# </rpc-reply>
#
- name: Parse routing-options running config
junipernetworks.junos.junos_routing_options:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
#
# "parsed": {
# "autonomous_system": {
# "as_number": "2",
# "asdot_notation": true,
# "loops": 4
# },
# "router_id": "12.12.12.12"
# }
#
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: |