onyx_bgp – Configures BGP on Mellanox ONYX network devices

New in version 2.5.

Synopsis
Parameters
Notes
Examples
Return Values
Status

Synopsis

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

Parameters

Parameter		Choices/Defaults	Comments
as_number - / required			Local AS number.
neighbors -			List of neighbors. Required if state=present.
	neighbor - / required		Neighbor IP address.
	remote_as - / required		Remote AS number.
networks -			List of advertised networks.
router_id -			Router IP address. Required if state=present.
state -		present ← absent	BGP state.

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
    state: present
    networks:
      - 172.16.1.0/24

Return Values

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

Key	Returned	Description
commands list	always	The list of configuration mode commands to send to the device. Sample: ['router bgp 172', 'exit', 'router bgp 172 router-id 2.3.4.5 force', 'router bgp 172 neighbor 2.3.4.6 remote-as 173', 'router bgp 172 network 172.16.1.0 /24']

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Samer Deeb (@samerd)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/onyx_bgp_module.html