community.general.onyx_bgp (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
vrf:
    description:
    - vrf name.

evpn:
    description:
    - Configure evpn peer-group.
    type: bool

purge:
    default: false
    description:
    - will remove all neighbors when it is True.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - BGP state.

networks:
    description:
    - List of advertised networks.

as_number:
    description:
    - Local AS number.
    required: true

max_paths:
    description:
    - Maximum bgp paths.

neighbors:
    description:
    - List of neighbors. Required if I(state=present).
    suboptions:
      multihop:
        description:
        - multihop number.
      neighbor:
        description:
        - Neighbor IP address.
        required: true
      remote_as:
        description:
        - Remote AS number.
        required: true

router_id:
    description:
    - Router IP address.

ecmp_bestpath:
    description:
    - Enables ECMP across AS paths.
    type: bool

fast_external_fallover:
    description:
    - will configure fast_external_fallover when it is True.
    type: bool

Outputs

commands:
  description: The list of configuration mode commands to send to the device.
  returned: always
  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
  type: list