mellanox.onyx.onyx_bgp – Configures BGP on Mellanox ONYX network devices

Note

This plugin is part of the mellanox.onyx collection (version 1.0.0).

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

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

Synopsis

  • This module provides declarative management of BGP router and neighbors on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
as_number
string / required
Local AS number.
ecmp_bestpath
boolean
    Choices:
  • no
  • yes
Enables ECMP across AS paths.
evpn
boolean
    Choices:
  • no
  • yes
Configure evpn peer-group.
fast_external_fallover
boolean
    Choices:
  • no
  • yes
will configure fast_external_fallover when it is True.
max_paths
string
Maximum bgp paths.
neighbors
string
List of neighbors. Required if state=present.
multihop
string
multihop number.
neighbor
string / required
Neighbor IP address.
remote_as
string / required
Remote AS number.
networks
string
List of advertised networks.
purge
boolean
    Choices:
  • no ←
  • yes
will remove all neighbors when it is True.
router_id
string
Router IP address.
state
string
    Choices:
  • present ←
  • absent
BGP state.
vrf
string
vrf name.

Notes

Note

  • Tested on ONYX 3.6.4000

Examples

- name: Configure bgp
  onyx_bgp:
    as_number: 320
    router_id: 10.3.3.3
    neighbors:
      - remote_as: 321
        neighbor: 10.3.3.4
      - remote_as: 322
        neighbor: 10.3.3.5
        multihop: 250
    purge: True
    state: present
    networks:
      - 172.16.1.0/24
    vrf: default
    evpn: yes
    fast_external_fallover: yes
    max_paths: 32
    ecmp_bestpath: yes

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 bgp 320 vrf default', 'exit', 'router bgp 320 router-id 10.3.3.3 force', 'router bgp 320 vrf default bgp fast-external-fallover', 'router bgp 320 vrf default maximum-paths 32', 'router bgp 320 vrf default bestpath as-path multipath-relax force', 'router bgp 320 vrf default neighbor evpn peer-group', 'router bgp 320 vrf default neighbor evpn send-community extended', 'router bgp 320 vrf default address-family l2vpn-evpn neighbor evpn next-hop-unchanged', 'router bgp 320 vrf default address-family l2vpn-evpn neighbor evpn activate', 'router bgp 320 vrf default address-family l2vpn-evpn auto-create', 'router bgp 320 vrf default neighbor 10.3.3.4 remote-as 321', 'router bgp 320 vrf default neighbor 10.3.3.4 ebgp-multihop 250', 'router bgp 320 vrf default neighbor 10.3.3.5 remote-as 322', 'router bgp 320 vrf default network 172.16.1.0 /24']


Authors

  • Samer Deeb (@samerd), Anas Badaha (@anasb)