junipernetworks.junos.junos_ospfv2 – OSPFv2 resource module

Note

This plugin is part of the junipernetworks.junos collection (version 1.3.0).

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

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module manages global OSPFv2 configuration on devices running Juniper JUNOS.

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.0)

Parameters

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	1g 10g	BW to apply metric to.
				metric integer		Specify metric
			flood_reduction boolean		no yes	Enable flood reduction.
			metric integer			Metric applied to the interface.
			name string / required			Name of the interface.
			passive boolean		no yes	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		no yes	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				1g 10g	Bandwidth for calculating metric defaults.
	rfc1583compatibility boolean				no yes	Set RFC1583 compatibility
	router_id string / required					The OSPFv2 router id.
	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					merged ← replaced overridden deleted gathered rendered parsed	The state the configuration should be left in.

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 merged
#
# Before state
# ------------
#
# admin# show protocols ospf

- name: Merge Junos OSPFv2 config
  junipernetworks.junos.junos_ospfv2:
    config:
    - router_id: 10.200.16.75
      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;
#     }
# }

Return Values

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']

Authors

Daniel Mellado (@dmellado)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/junipernetworks/junos/junos_ospfv2_module.html