Try SpotterOSPF Interfaces Resource Module.
| "added in version" 1.3.0 of junipernetworks.junos"
Authors: Rohit Thakur (@rohitthakur2590)
preview | supported by network
Install with ansible-galaxy collection install junipernetworks.junos:==8.0.0
collections:
- name: junipernetworks.junos
version: 8.0.0This module manages OSPF(v2/v3) configuration of interfaces on devices running Juniper JUNOS.
# Using merged
#
# Before state
# ------------
#
# admin# show protocols ospf
- name: Merge Junos OSPF interfaces config
junipernetworks.junos.junos_ospf_interfaces:
config:
- name: 'ge-0/0/2.0'
address_family:
- afi: 'ipv4'
processes:
area:
area_id: '0.0.0.2'
priority: 3
metric: 5
state: merged
# After state
# -----------
#
# admin# show protocols ospf
# area 0.0.0.2 {
# interface ge-0/0/2.0 {
# metric 5;
# priority 3;
# }
# }
# Using replaced
#
# Before state
# ------------
#
# admin# show protocols ospf
# area 0.0.0.2 {
# interface ge-0/0/2.0 {
# metric 5;
# priority 3;
# }
# }
- name: Replace Junos OSPF interfaces config
junipernetworks.junos.junos_ospf_interfaces:
config:
- name: 'ge-0/0/2.0'
address_family:
- afi: 'ipv4'
processes:
area:
area_id: '0.0.0.1'
priority: 6
metric: 6
state: replaced
# After state
# -----------
#
# admin# show protocols ospf
# area 0.0.0.1 {
# interface ge-0/0/2.0 {
# metric 6;
# priority 6;
# }
# }
# Using overridden
#
# Before state
# ------------
#
# admin# show protocols ospf
# area 0.0.0.3 {
# interface ge-0/0/3.0 {
# metric 5;
# priority 3;
# }
# }
# area 0.0.0.2 {
# interface ge-0/0/2.0 {
# metric 5;
# priority 3;
# }
# }
- name: Override Junos OSPF interfaces config
junipernetworks.junos.junos_ospf_interfaces:
config:
- name: 'ge-0/0/1.0'
address_family:
- afi: 'ipv4'
processes:
area:
area_id: '0.0.0.1'
priority: 3
metric: 5
state: overridden
# After state
# -----------
#
# admin# show protocols ospf
# area 0.0.0.1 {
# interface ge-0/0/1.0 {
# metric 5;
# priority 3;
# }
# }
#
# Using deleted
#
# Before state
# ------------
#
# admin# show protocols ospf
# area 0.0.0.1 {
# interface ge-0/0/1.0 {
# metric 5;
# priority 3;
# }
# }
- name: Delete Junos OSPF interfaces config
junipernetworks.junos.junos_ospf_interfaces:
config:
- name: 'ge-0/0/1.0'
state: deleted
# After state
# -----------
#
# admin# show protocols ospf
# Using gathered
#
# Before state
# ------------
#
# admin# show protocols ospf
# area 0.0.0.3 {
# interface ge-0/0/3.0 {
# metric 5;
# priority 3;
# }
# }
# area 0.0.0.2 {
# interface ge-0/0/2.0 {
# metric 5;
# priority 3;
# }
# }
- name: Gather Junos OSPF interfaces config
junipernetworks.junos.junos_ospf_interfaces:
config:
state: gathered
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
# "gathered": [
# {
# "address_family": [
# {
# "afi": "ipv4",
# "processes": {
# "area": {
# "area_id": "0.0.0.3"
# },
# "metric": 5,
# "priority": 3
# }
# }
# ],
# "name": "ge-0/0/3.0",
# },
# {
# "address_family": [
# {
# "afi": "ipv4",
# "processes": {
# "area": {
# "area_id": "0.0.0.2"
# },
# "metric": 5,
# "priority": 3
# }
# }
# ],
# "name": "ge-0/0/2.0",
# }
# ]
#
# Using rendered
#
#
- name: Render the commands for provided configuration
junipernetworks.junos.junos_ospf_interfaces:
config:
- name: 'ge-0/0/2.0'
address_family:
- afi: 'ipv4'
processes:
area:
area_id: '0.0.0.2'
priority: 3
metric: 5
state: rendered
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
#
# "rendered": "
# <nc:protocols
# xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:ospf>
# <nc:area>
# <nc:name>0.0.0.2</nc:name>
# <nc:interface>
# <nc:name>ge-0/0/2.0</nc:name>
# <nc:priority>3</nc:priority>
# <nc:metric>5</nc:metric>
# </nc:interface>
# </nc:area>
# </nc:ospf>
# </nc:protocols>"
#
# 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">
# <protocols>
# <ospf>
# <area>
# <name>0.0.0.2</name>
# <stub>
# <default-metric>200</default-metric>
# </stub>
# <interface>
# <name>ge-0/0/2.0</name>
# <metric>5</metric>
# <priority>3</priority>
# </interface>
# </area>
# </ospf>
# </protocols>
# <routing-options>
# <router-id>10.200.16.75</router-id>
# </routing-options>
# </configuration>
# </rpc-reply>
- name: Parsed the device configuration to get output commands
junipernetworks.junos.junos_ospf_interfaces:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
state:
choices:
- merged
- replaced
- overridden
- deleted
- parsed
- gathered
- rendered
default: merged
description:
- The state the configuration should be left in.
type: str
config:
description: A list of OSPF configuration for interfaces.
elements: dict
suboptions:
address_family:
description:
- OSPF settings on the interfaces in address-family context.
elements: dict
suboptions:
afi:
choices:
- ipv4
- ipv6
description:
- Address Family Identifier (AFI) for OSPF settings on the interfaces.
required: true
type: str
processes:
description:
- Interfaces configuration for an OSPF process.
suboptions:
area:
description: Specify the area-id
suboptions:
area_id:
description: Specify area id.
type: str
type: dict
authentication:
description: Specify authentication type
suboptions:
md5:
description:
- Specify md5 based authentication.
elements: dict
suboptions:
key_id:
description: Specify md5 key-id
type: int
key_value:
description: Specify key value
type: str
start_time:
description: Specify start time for key transmission
type: str
type: list
simple_password:
description:
- Specify password for authentication.
type: str
type: dict
bandwidth_based_metrics:
description: Specify list of bandwidth based metrics
elements: dict
suboptions:
bandwidth:
choices:
- 1g
- 10g
description:
- BW to apply metric to.
type: str
metric:
description: Specify metric
type: int
type: list
dead_interval:
description:
- Dead interval (seconds).
type: int
demand_circuit:
description:
- Interface functions as a demand circuit.
type: bool
flood_reduction:
description:
- Enable flood reduction.
type: bool
hello_interval:
description:
- Hello interval (seconds).
type: int
interface_type:
choices:
- nbma
- p2mp
- p2p
description: Specify type of interface
type: str
ipsec_sa:
description:
- IPSec security association name
type: str
metric:
description:
- Metric applied to the interface.
type: int
mtu:
description:
- Maximum OSPF packet size
type: int
no_advertise_adjacency_segment:
description:
- Do not advertise an adjacency segment for this interface.
type: bool
no_eligible_backup:
description:
- Not eligible to backup traffic from protected interfaces.
type: bool
no_eligible_remote_backup:
description:
- Not eligible for Remote-LFA backup traffic from protected interfaces.
type: bool
no_interface_state_traps:
description:
- Do not send interface state change traps.
type: bool
no_neighbor_down_notification:
description:
- Don't inform other protocols about neighbor down events.
type: bool
node_link_protection:
description:
- Protect interface from both link and node faults.
type: bool
passive:
description:
- Do not run OSPF, but advertise it.
type: bool
poll_interval:
description:
- Poll interval (seconds).
type: int
priority:
description:
- Priority for the interface.
type: int
retransmit_interval:
description:
- Retransmit interval (seconds).
type: int
secondary:
description:
- Treat interface as secondary
type: bool
te_metric:
description:
- Traffic engineering metric applied to the interface.
type: int
transit_delay:
description:
- Transit delay (seconds).
type: int
type: dict
type: list
name:
description:
- Name/Identifier of the interface.
required: true
type: str
router_id:
description:
- The OSPF router id.
type: str
type: list
running_config:
description:
- This option is used only with state I(parsed).
- The value of this option should be the output received from the Junos device by
executing the command B(show protocols ospf).
- The state I(parsed) reads the configuration from C(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 I(parsed) key within the result
type: str
after:
description: The resulting configuration model invocation.
returned: when changed
sample: "The configuration returned will always be in the same format\n of the parameters\
\ above.\n"
type: dict
before:
description: The configuration prior to the model invocation.
returned: always
sample: "The configuration returned will always be in the same format\n of the parameters\
\ above.\n"
type: dict
commands:
description: The set of commands pushed to the remote device.
returned: always
sample:
- <nc:protocols xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:ospf> <nc:area>
<nc:name>0.0.0.3</nc:name> <nc:interface> <nc:name>ge-0/0/3.0</nc:name> <nc:priority>3</nc:priority>
<nc:metric>5</nc:metric> </nc:interface> </nc:area> <nc:area> <nc:name>0.0.0.2</nc:name>
<nc:interface> <nc:name>ge-0/0/2.0</nc:name> <nc:priority>3</nc:priority> <nc:metric>5</nc:metric>
</nc:interface> </nc:area> </nc:ospf> </nc:protocols>", " <nc:routing-options
xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:router-id>10.200.16.75</nc:router-id>
<nc:router-id>10.200.16.75</nc:router-id> </nc:routing-options>
- xml 2
- xml 3
type: list