mellanox.onyx.onyx_ospf – Manage OSPF protocol on Mellanox ONYX network devices

Note

This plugin is part of the mellanox.onyx collection.

To install it use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_ospf.

Synopsis

  • This module provides declarative management and configuration of OSPF protocol on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
interfaces
string
List of interfaces and areas. Required if state=present.
area
string / required
OSPF area.
name
string / required
Interface name.
ospf
string / required
OSPF instance number 1-65535
router_id
string
OSPF router ID. Required if state=present.
state
string
    Choices:
  • present ←
  • absent
OSPF state.

Notes

Note

  • Tested on ONYX 3.6.4000

Examples

- name: Add ospf router to interface
  onyx_ospf:
    ospf: 2
    router_id: 192.168.8.2
    interfaces:
      - name: Eth1/1
      - area: 0.0.0.0

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list / elements=string
always
The list of configuration mode commands to send to the device.

Sample:
['router ospf 2', 'router-id 192.168.8.2', 'exit', 'interface ethernet 1/1 ip ospf area 0.0.0.0']


Authors

  • Samer Deeb (@samerd)