New in version 2.5.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
as_number
required |
Local AS number.
|
||
neighbors |
List of neighbors. Required if state=present.
|
||
remote_as
required |
Remote AS number.
|
||
neighbor
required |
Neighbor IP address.
|
||
networks |
List of advertised networks.
|
||
router_id |
Router IP address. Required if state=present.
|
||
state |
|
BGP state.
|
- 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
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']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.