.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.amnesh.soodar.soodar_ospfv2_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title amnesh.soodar.soodar_ospfv2 module -- Manages and configures Open Shortest Path First (OSPF) version 2 and it's attributes. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `amnesh.soodar collection `_ (version 1.0.0). To install it, use: :code:`ansible-galaxy collection install https://soodar.ir/ansible/amnesh.soodar.tar.gz`. To use it in a playbook, specify: :code:`amnesh.soodar.soodar_ospfv2`. .. version_added .. rst-class:: ansible-version-added New in amnesh.soodar 1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module configures and manages the Open Shortest Path First (OSPF) version 2 on Soodar platforms. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

A dictionary of OSPF options. .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes: .. rst-class:: ansible-option-title **processes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

List of OSPF instance configurations. .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas: .. rst-class:: ansible-option-title **areas** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

OSPF area parameters .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/area_id: .. rst-class:: ansible-option-title **area_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

OSPF area ID as a decimal value. Please refer vendor documentation of Valid values. OSPF area ID in IP address format(e.g. A.B.C.D) .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/authentication: .. rst-class:: ansible-option-title **authentication** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Area authentication .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/authentication/enable: .. rst-class:: ansible-option-title **enable** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Enable area authentication .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/authentication/message_digest: .. rst-class:: ansible-option-title **message_digest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Use IPsec authentication .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/default_cost: .. rst-class:: ansible-option-title **default_cost** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Set the summary default-cost of a NSSA/stub area Stub's advertised external route metric Note, please refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/filter_list: .. rst-class:: ansible-option-title **filter_list** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Filter networks between OSPF areas .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/filter_list/direction: .. rst-class:: ansible-option-title **direction** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

The direction to apply on the filter networks sent to and from this area. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"in"` - :ansible-option-choices-entry:`"out"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/filter_list/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Name of an IP prefix-list .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/nssa: .. rst-class:: ansible-option-title **nssa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Specify a NSSA area .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/nssa/no_summary: .. rst-class:: ansible-option-title **no_summary** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Do not send summary LSA into NSSA .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/nssa/set: .. rst-class:: ansible-option-title **set** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Enable a NSSA area .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/nssa/translate: .. rst-class:: ansible-option-title **translate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Translate LSA Configure for translate election Always translate LSAs on this ABR Never translate LSAs on this ABR .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"translate-always"` - :ansible-option-choices-entry:`"translate-never"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/ranges: .. rst-class:: ansible-option-title **ranges** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Summarize routes matching address/mask (border routers only) .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/ranges/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

IP prefix to match .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/ranges/advertise: .. rst-class:: ansible-option-title **advertise** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Advertise this range (default) Since, advertise when enabled is not shown in running-config idempotency won't be maintained for the play in the second or next run of the play. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/ranges/cost: .. rst-class:: ansible-option-title **cost** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

User specified metric for this range .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/ranges/not_advertise: .. rst-class:: ansible-option-title **not_advertise** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

DoNotAdvertise this range .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/stub: .. rst-class:: ansible-option-title **stub** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Specify a stub area Backbone can not be configured as stub area .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/stub/no_summary: .. rst-class:: ansible-option-title **no_summary** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Do not send summary LSA into stub area .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/areas/stub/set: .. rst-class:: ansible-option-title **set** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Enable a stub area .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/auto_cost: .. rst-class:: ansible-option-title **auto_cost** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Calculate OSPF interface cost according to bandwidth .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/auto_cost/reference_bandwidth: .. rst-class:: ansible-option-title **reference_bandwidth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Use reference bandwidth method to assign OSPF cost Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/auto_cost/set: .. rst-class:: ansible-option-title **set** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Enable OSPF auto-cost .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/compatible: .. rst-class:: ansible-option-title **compatible** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

OSPF router compatibility list .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/compatible/rfc1583: .. rst-class:: ansible-option-title **rfc1583** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

compatible with RFC 1583 .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/default_information: .. rst-class:: ansible-option-title **default_information** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Control distribution of default information .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/default_information/always: .. rst-class:: ansible-option-title **always** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Always advertise default route .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/default_information/metric: .. rst-class:: ansible-option-title **metric** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

OSPF default metric Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/default_information/metric_type: .. rst-class:: ansible-option-title **metric_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

OSPF metric type for default routes Note, please refer vendor documentation for respective valid range .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/default_information/route_map: .. rst-class:: ansible-option-title **route_map** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Route-map reference name .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/default_metric: .. rst-class:: ansible-option-title **default_metric** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Set metric of redistributed routes .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distance: .. rst-class:: ansible-option-title **distance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Define an administrative distance .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distance/admin_distance: .. rst-class:: ansible-option-title **admin_distance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

OSPF Administrative distance .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distance/admin_distance/distance: .. rst-class:: ansible-option-title **distance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Administrative distance .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distance/ospf: .. rst-class:: ansible-option-title **ospf** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

OSPF distance .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distance/ospf/external: .. rst-class:: ansible-option-title **external** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

External type 5 and type 7 routes .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distance/ospf/inter_area: .. rst-class:: ansible-option-title **inter_area** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Inter-area routes .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distance/ospf/intra_area: .. rst-class:: ansible-option-title **intra_area** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Intra-area routes .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distribute_list: .. rst-class:: ansible-option-title **distribute_list** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Filter networks in routing updates .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distribute_list/acls: .. rst-class:: ansible-option-title **acls** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

IP access list .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distribute_list/acls/direction: .. rst-class:: ansible-option-title **direction** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

Filter incoming and outgoing routing updates. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"out"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distribute_list/acls/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

IP access list name/number .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/distribute_list/acls/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Protocol config (bgp 1). Valid with outgoing traffic .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/log_adjacency_changes: .. rst-class:: ansible-option-title **log_adjacency_changes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Log changes in adjacency state .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/log_adjacency_changes/detail: .. rst-class:: ansible-option-title **detail** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Log all state changes .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/log_adjacency_changes/set: .. rst-class:: ansible-option-title **set** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Log changes in adjacency state .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/max_metric: .. rst-class:: ansible-option-title **max_metric** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Set maximum metric .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/max_metric/on_startup: .. rst-class:: ansible-option-title **on_startup** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Set maximum metric temporarily after reboot .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/max_metric/on_startup/time: .. rst-class:: ansible-option-title **time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Time, in seconds, router-LSAs are originated with max-metric Note, please refer vendor documentation for respective valid range .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/max_metric/router_lsa: .. rst-class:: ansible-option-title **router_lsa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

Maximum metric in self-originated router-LSAs .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/neighbor: .. rst-class:: ansible-option-title **neighbor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Specify a neighbor router .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/neighbor/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Neighbor address (A.B.C.D) .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/neighbor/poll_interval: .. rst-class:: ansible-option-title **poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

OSPF dead-router polling interval of non-broadcast neighbor in Seconds .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/neighbor/priority: .. rst-class:: ansible-option-title **priority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

OSPF priority of non-broadcast neighbor priority .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Enable routing on an IP network .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/network/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Network number .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/network/area: .. rst-class:: ansible-option-title **area** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Set the OSPF area ID .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/passive_interface: .. rst-class:: ansible-option-title **passive_interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

passive\_interface param is deprecated and a newer param passive\_interfaces with added functionality's is introduced, please meke use of the new available passive\_interfaces instead. Suppress routing updates on an interface (GigabitEthernet A/B) Interface name with respective interface number .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/passive_interfaces: .. rst-class:: ansible-option-title **passive_interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Suppress routing updates on an interface .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/passive_interfaces/default: .. rst-class:: ansible-option-title **default** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Suppress routing updates on all interfaces .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/passive_interfaces/interface: .. rst-class:: ansible-option-title **interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Suppress/Un-Suppress routing updates on interface .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/passive_interfaces/interface/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html

- .. raw:: html

Name of interface (GigabitEthernet A/B) .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/passive_interfaces/interface/set_interface: .. rst-class:: ansible-option-title **set_interface** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Suppress/Un-Suppress routing updates .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/prefix_suppression: .. rst-class:: ansible-option-title **prefix_suppression** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Enable prefix suppression .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/priority: .. rst-class:: ansible-option-title **priority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

OSPF topology priority Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/process_id: .. rst-class:: ansible-option-title **process_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

Process ID .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/router_id: .. rst-class:: ansible-option-title **router_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Router-id address for this OSPF process OSPF router-id in IP address format (A.B.C.D) .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers: .. rst-class:: ansible-option-title **timers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Adjust routing timers .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/lsa: .. rst-class:: ansible-option-title **lsa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

OSPF LSA timers, arrival timer The minimum interval in milliseconds between accepting the same LSA Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/pacing: .. rst-class:: ansible-option-title **pacing** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

OSPF pacing timers .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/pacing/retransmission: .. rst-class:: ansible-option-title **retransmission** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

OSPF retransmission pacing timer The minimum interval in msec between neighbor retransmissions Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/throttle: .. rst-class:: ansible-option-title **throttle** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

OSPF throttle timers .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/throttle/lsa: .. rst-class:: ansible-option-title **lsa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

OSPF LSA throttle timers .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/throttle/lsa/delay: .. rst-class:: ansible-option-title **delay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Delay of all LSA parameters in milliseconds Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/throttle/spf: .. rst-class:: ansible-option-title **spf** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

OSPF SPF throttle timers - Delay between receiving a change to SPF calculation in milliseconds - Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/throttle/spf/between_delay: .. rst-class:: ansible-option-title **between_delay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Delay between first and second SPF calculation in milliseconds Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/throttle/spf/max_delay: .. rst-class:: ansible-option-title **max_delay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Maximum wait time in milliseconds for SPF calculations Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/timers/throttle/spf/receive_delay: .. rst-class:: ansible-option-title **receive_delay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Delay between receiving a change to SPF calculation in milliseconds Note, refer vendor documentation for respective valid values .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-config/processes/vrf: .. rst-class:: ansible-option-title **vrf** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Specify parameters for a VPN Routing/Forwarding instance .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-running_config: .. rst-class:: ansible-option-title **running_config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

This option is used only with state \ :emphasis:`parsed`\ . The value of this option should be the output received from the Soodar device by executing the command \ :strong:`sh running-config | section ^router ospf`\ . The state \ :emphasis:`parsed`\ reads the configuration from \ :literal:`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 \ :emphasis:`parsed`\ key within the result. .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The state the configuration should be left in The states \ :emphasis:`rendered`\ , \ :emphasis:`gathered`\ and \ :emphasis:`parsed`\ does not perform any change on the device. The state \ :emphasis:`rendered`\ will transform the configuration in \ :literal:`config`\ option to platform specific CLI commands which will be returned in the \ :emphasis:`rendered`\ key within the result. For state \ :emphasis:`rendered`\ active connection to remote host is not required. The state \ :emphasis:`gathered`\ will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the \ :emphasis:`gathered`\ key within the result. The state \ :emphasis:`parsed`\ reads the configuration from \ :literal:`running\_config`\ option and transforms it into JSON format as per the resource module parameters and the value is returned in the \ :emphasis:`parsed`\ key within the result. The value of \ :literal:`running\_config`\ option should be the same format as the output of command \ :emphasis:`show running-config | include ip route|ipv6 route`\ executed on device. For state \ :emphasis:`parsed`\ active connection to remote host is not required. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"replaced"` - :ansible-option-choices-entry:`"overridden"` - :ansible-option-choices-entry:`"deleted"` - :ansible-option-choices-entry:`"gathered"` - :ansible-option-choices-entry:`"parsed"` - :ansible-option-choices-entry:`"rendered"` .. raw:: html

.. Attributes .. Notes Notes ----- .. note:: - Tested against Soodar Version 21.04 .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja # Using Deleted # # Before state # ------------- # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # max-metric router-lsa on-startup 100 # auto-cost reference-bandwidth 4 # area 0 range 192.168.19.0/24 not-advertise # area 0 range 192.168.19.0/24 cost 10 # distribute-list 10 out # router ospf 1 # max-metric router-lsa on-startup 110 # area 0 authentication # area 1 authentication message-digest # area 1 nssa translate-never # area 1 default-cost 10 # area 1 filter-list prefix test_prefix_in in # area 1 filter-list prefix test_prefix_out out # network 198.51.100.0/24 area 0 # default-information originate - name: Delete provided OSPF processes amnesh.soodar.soodar_ospfv2: config: processes: - id: 1 - id: 200 vrf: blue state: deleted # # # ------------------------ # Module Execution Results # ------------------------ # "commands": [ # "no router ospf 200 vrf blue", # "no router ospf 1" # ] # After state # ------------ # soodar# sh running-config | section ^router ospf # soodar# # Using Merged # # Before state # ------------- # soodar# sh running-config | section ^router ospf # soodar# - name: Merge provided configuration amnesh.soodar.soodar_ospfv2: config: processes: - process_id: 1 max_metric: router_lsa: true on_startup: time: 110 areas: - area_id: "5" authentication: enable: true - area_id: "10" authentication: message_digest: true nssa: translate: never-translate default_cost: 10 filter_list: - name: test_prefix_in direction: in - name: test_prefix_out direction: out network: address: 198.51.100.0/24 area: 5 default_information: originate: true - process_id: 200 vrf: blue max_metric: router_lsa: true on_startup: time: 100 auto_cost: reference_bandwidth: 4 areas: - area_id: "10" ranges: - address: 192.168.19.0/24 not_advertise: true cost: 10 distribute_list: acls: - name: 10 direction: out state: merged # ------------------------ # Module Execution Results # ------------------------ # # "commands": [ # "router ospf 200 vrf blue", # "auto-cost reference-bandwidth 4", # "distribute-list 10 out", # "max-metric router-lsa on-startup 100", # "area 10 range 192.168.19.0/24 cost 10", # "area 10 range 192.168.19.0/24 not-advertise", # "router ospf 1", # "default-information originate", # "max-metric router-lsa on-startup 110", # "network 198.51.100.0/24 area 5", # "area 10 authentication message-digest", # "area 10 default-cost 10", # "area 10 nssa translate translate-never", # "area 10 filter-list prefix test_prefix_out out", # "area 10 filter-list prefix test_prefix_in in", # "area 5 authentication", # ] # After state # ------------ # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # max-metric router-lsa on-startup 100 # auto-cost reference-bandwidth 4 # area 10 range 192.168.19.0/24 cost 10 # area 10 range 192.168.19.0/24 not-advertise # distribute-list 10 out # router ospf 1 # max-metric router-lsa on-startup 110 # area 5 authentication # area 10 authentication message-digest # area 10 nssa translate translate-never # area 10 default-cost 10 # area 10 filter-list prefix test_prefix_in in # area 10 filter-list prefix test_prefix_out out # network 198.51.100.0/24 area 5 # default-information originate # Using replaced # Before state: # ------------- # # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # max-metric router-lsa on-startup 100 # auto-cost reference-bandwidth 4 # distribute-list 10 out # router ospf 1 # max-metric router-lsa on-startup 110 # area 10 authentication message-digest # area 10 nssa translate translate-never # area 10 default-cost 10 # area 10 filter-list prefix test_prefix_out out # network 198.51.100.0/24 area 5 # default-information originate - name: Replaced provided OSPF V2 configuration amnesh.soodar.soodar_ospfv2: config: processes: - process_id: 200 vrf: blue max_metric: router_lsa: true on_startup: time: 200 areas: - area_id: '10' default_cost: 10 authentication: message_digest: true - process_id: 100 vrf: ospf_vrf auto_cost: reference_bandwidth: 5 areas: - area_id: '5' authentication: message_digest: true nssa: translate: translate-never state: replaced # Commands Fired: # --------------- # "commands": [ # "router ospf 100 vrf ospf_vrf", # "auto-cost reference-bandwidth 5", # "area 5 authentication message-digest", # "area 5 nssa translate translate-never", # "router ospf 200 vrf blue", # "no auto-cost reference-bandwidth 4", # "no distribute-list 10 out", # "max-metric router-lsa on-startup 200", # "area 10 authentication message-digest", # "area 10 default-cost 10" # ] # After state: # ------------- # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # area 10 authentication message-digest # area 10 default-cost 10 # router ospf 100 vrf ospf_vrf # auto-cost reference-bandwidth 5 # area 5 authentication message-digest # area 5 nssa translate translate-never # router ospf 1 # max-metric router-lsa on-startup 110 # area 5 authentication # area 10 authentication message-digest # area 10 nssa translate translate-never # area 10 default-cost 10 # area 10 filter-list prefix test_prefix_in in # area 10 filter-list prefix test_prefix_out out # network 198.51.100.0/24 area 5 # default-information originate # Before state: # ------------- # # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # max-metric router-lsa on-startup 100 # auto-cost reference-bandwidth 4 # distribute-list 10 out # router ospf 1 # max-metric router-lsa on-startup 110 # area 10 authentication message-digest # area 10 nssa translate translate-never # area 10 default-cost 10 # area 10 filter-list prefix test_prefix_out out # network 198.51.100.0/24 area 5 # default-information originate - name: Override provided OSPF V2 configuration amnesh.soodar.soodar_ospfv2: config: processes: - process_id: 200 vrf: blue max_metric: router_lsa: true on_startup: time: 200 areas: - area_id: '10' default_cost: 10 authentication: message_digest: true - process_id: 100 vrf: ospf_vrf auto_cost: reference_bandwidth: 5 areas: - area_id: '5' authentication: message_digest: true nssa: translate: translate-never state: overridden # Commands Fired: # --------------- # # "commands": [ # "no router ospf 1", # "router ospf 100 vrf ospf_vrf", # "auto-cost reference-bandwidth 5", # "area 5 authentication message-digest", # "area 5 nssa translate translate-never", # "router ospf 200 vrf blue", # "no auto-cost reference-bandwidth 4", # "no distribute-list 10 out", # "max-metric router-lsa on-startup 200", # "area 10 authentication message-digest", # "area 10 default-cost 10" # ] # After state: # ------------- # # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # max-metric router-lsa on-startup 200 # area 10 authentication message-digest # area 10 default-cost 10 # router ospf 100 vrf ospf_vrf # auto-cost reference-bandwidth 5 # area 5 authentication message-digest # area 5 nssa translate translate-never # Using Gathered # # Before state # ------------- # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # max-metric router-lsa on-startup 100 # auto-cost reference-bandwidth 4 # distribute-list 10 out # router ospf 1 # max-metric router-lsa on-startup 110 # area 0 authentication # area 1 authentication message-digest # area 1 nssa translate-never # area 1 default-cost 10 # area 1 filter-list prefix test_prefix_out out # network 198.51.100.0/24 area 0 # default-information originate - name: Gather OSPF V2 provided configuration amnesh.soodar.soodar_ospfv2: config: state: gathered # Module Execution Result: # ------------------------ # # "gathered": { # "processes": [ # { # "areas": [ # { # "area_id": "5", # "authentication": { # "enable": true # }, # }, # { # "area_id": "10", # "authentication": { # "message_digest": true # }, # "default_cost": 10, # "filter_list": [ # { # "direction": "in", # "name": "test_prefix_in" # }, # { # "direction": "out", # "name": "test_prefix_out" # } # ], # "nssa": { # "translate": "translate-never" # } # } # ], # "default_information": { # "originate": true # }, # "max_metric": { # "on_startup": { # "time": 110 # }, # "router_lsa": true # }, # "network": { # "address": "198.51.100.0/24", # "area": "5", # }, # "process_id": 1 # }, # { # "areas": [ # { # "area_id": "10", # } # ], # "auto_cost": { # "reference_bandwidth": 4 # }, # "distribute_list": { # "acls": [ # { # "direction": "out", # "name": "10" # }, # ] # }, # "max_metric": { # "on_startup": { # "time": 100 # }, # "router_lsa": true # }, # "process_id": 200, # "vrf": "blue" # } # ] # } # After state: # ------------ # # soodar# sh running-config | section ^router ospf # router ospf 200 vrf blue # max-metric router-lsa on-startup 100 # auto-cost reference-bandwidth 4 # distribute-list 10 out # router ospf 1 # max-metric router-lsa on-startup 110 # area 0 authentication # area 1 authentication message-digest # area 1 nssa translate-never # area 1 default-cost 10 # area 1 filter-list prefix test_prefix_out out # network 198.51.100.0/24 area 0 # default-information originate # Using Rendered - name: Render the commands for provided configuration amnesh.soodar.soodar_ospfv2: config: processes: - process_id: 1 max_metric: router_lsa: true on_startup: time: 110 areas: - area_id: '5' authentication: enable: true - area_id: '10' authentication: message_digest: true nssa: translate: translate-never default_cost: 10 filter_list: - name: test_prefix_in direction: in - name: test_prefix_out direction: out network: address: 198.51.100.0/24 area: 5 default_information: originate: true - process_id: 200 vrf: blue max_metric: router_lsa: true on_startup: time: 100 auto_cost: reference_bandwidth: 4 areas: - area_id: '10' distribute_list: acls: - name: 10 direction: out state: rendered # Module Execution Result: # ------------------------ # # "rendered": [ # "router ospf 200 vrf blue", # "auto-cost reference-bandwidth 4", # "distribute-list 10 out", # "max-metric router-lsa on-startup 100", # "router ospf 1", # "default-information originate", # "max-metric router-lsa on-startup 110", # "network 198.51.100.0/24 area 5", # "area 10 authentication message-digest", # "area 10 default-cost 10", # "area 10 nssa translate translate-never", # "area 10 filter-list prefix test_prefix_out out", # "area 10 filter-list prefix test_prefix_in in", # "area 5 authentication", # ] # Using Parsed # File: parsed.cfg # ---------------- # # router ospf 100 # auto-cost reference-bandwidth 5 # area 5 authentication message-digest # area 5 nssa translate translate-never - name: Parse the provided configuration with the existing running configuration amnesh.soodar.soodar_ospfv2: running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed # Module Execution Result: # ------------------------ # # "parsed": { # "processes": [ # { # "areas": [ # { # "area_id": "5", # "authentication": { # "message_digest": true # }, # "nssa": { # "translate": "translate-never" # } # } # ], # "auto_cost": { # "reference_bandwidth": 5 # }, # "process_id": 100 # } # ] # } .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__return-after: .. rst-class:: ansible-option-title **after** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

The resulting configuration model invocation. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when changed .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"The configuration returned will always be in the same format of the parameters above.\\n"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__return-before: .. rst-class:: ansible-option-title **before** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

The configuration prior to the model invocation. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"The configuration returned will always be in the same format of the parameters above.\\n"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.amnesh.soodar.soodar_ospfv2_module__return-commands: .. rst-class:: ansible-option-title **commands** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html

- .. raw:: html

The set of commands pushed to the remote device. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["router ospf 200 vrf blue", "auto-cost reference-bandwidth 5", "router-id 192.0.4.1"]` .. raw:: html

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Mahdi Varasteh (@m-varasteh) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html

Issue Tracker Homepage

.. Parsing errors