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

Note

This module is part of the mellanox.onyx collection (version 1.0.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 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

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

OSPF state.

Choices:

  • present ← (default)

  • absent

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

Description

commands

list / elements=string

The list of configuration mode commands to send to the device.

Returned: always

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)