Note
This plugin is part of the junipernetworks.junos collection (version 2.6.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.
To use it in a playbook, specify: junipernetworks.junos.junos_ospfv2.
New in version 1.0.0: of junipernetworks.junos
Note
This module has a corresponding action plugin.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | ||||
|---|---|---|---|---|---|---|
| config list / elements=dictionary | A list of OSPFv2 process configuration. | |||||
| areas list / elements=dictionary | A list of OSPFv2 areas' configuration. | |||||
| area_id string / required | The Area ID as an integer or IP Address. | |||||
| area_range string | Configure an address range for the area. | |||||
| interfaces list / elements=dictionary | List of interfaces in this area. | |||||
| authentication dictionary | Specify authentication type | |||||
| type dictionary | Type of authentication to use. | |||||
| bandwidth_based_metrics list / elements=dictionary | Specify list of bandwidth based metrics | |||||
| bandwidth string |
| BW to apply metric to. | ||||
| metric integer | Specify metric | |||||
| flood_reduction boolean |
| Enable flood reduction. | ||||
| metric integer | Metric applied to the interface. | |||||
| name string / required | Name of the interface. | |||||
| passive boolean |
| Specify passive | ||||
| priority integer | Priority for the interface. | |||||
| timers dictionary | Specify timers | |||||
| dead_interval integer | Dead interval (seconds). | |||||
| hello_interval integer | Hello interval (seconds). | |||||
| poll_interval integer | Poll interval (seconds). | |||||
| retransmit_interval integer | Retransmit interval (seconds). | |||||
| transit_delay integer | Transit delay (seconds). | |||||
| stub dictionary | Settings for configuring the area as a stub. | |||||
| default_metric integer | Metric for the default route in this area. | |||||
| set boolean |
| Configure the area as a stub. | ||||
| external_preference integer | Preference of external routes. | |||||
| overload dictionary | Specify time for overload mode reset | |||||
| timeout integer | Time after which overload mode is reset (seconds). | |||||
| preference integer | Preference of internal routes. | |||||
| prefix_export_limit integer | Maximum number of external prefixes that can be exported. | |||||
| reference_bandwidth string |
| Bandwidth for calculating metric defaults. | ||||
| rfc1583compatibility boolean |
| Set RFC1583 compatibility | ||||
| router_id string | The OSPFv2 router id. This option is DEPRECATED and will be replaced with router_id attribute of junos_routing_options resource_module. This attribute will be removed after 2024-01-01. | |||||
| spf_options dictionary | Configure options for SPF. | |||||
| delay integer | Time to wait before running an SPF (seconds). | |||||
| holddown integer | Time to hold down before running an SPF (seconds). | |||||
| rapid_runs integer | Number of maximum rapid SPF runs before holddown (seconds). | |||||
| running_config string | 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 B(show protocols ospf. 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. | ||||
Note
netconf.# Using merged
#
# Before state
# ------------
#
# admin# show protocols ospf
- name: Merge Junos OSPFv2 config
junipernetworks.junos.junos_ospfv2:
config:
- reference_bandwidth: 10g
areas:
- area_id: 0.0.0.100
area_range: 10.200.16.0/24
stub:
default_metric: 100
set: true
interfaces:
- name: so-0/0/0.0
priority: 3
metric: 5
flood_reduction: false
passive: true
bandwidth_based_metrics:
- bandwidth: 1g
metric: 5
- bandwidth: 10g
metric: 40
timers:
dead_interval: 4
hello_interval: 2
poll_interval: 2
retransmit_interval: 2
rfc1583compatibility: false
state: merged
# After state
# -----------
#
# admin# show protocols ospf
# reference-bandwidth 10g;
# no-rfc-1583;
# area 0.0.0.100 {
# stub default-metric 100;
# area-range 10.200.16.0/24;
# interface so-0/0/0.0 {
# passive;
# bandwidth-based-metrics {
# bandwidth 1g metric 5;
# bandwidth 10g metric 40;
# }
# metric 5;
# priority 3;
# retransmit-interval 2;
# hello-interval 2;
# dead-interval 4;
# poll-interval 2;
# }
# }
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| after dictionary | when changed | The resulting configuration model invocation. Sample: The configuration returned will always be in the same format of the parameters above. |
| before dictionary | 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: ['command 1', 'command 2', 'command 3'] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/junipernetworks/junos/junos_ospfv2_module.html