| Parameter |
Choices/Defaults |
Comments |
|
config
dictionary
|
|
A dict of BGP global configuration for interfaces.
|
|
as_number
integer
|
|
AS number.
|
|
bgp_params
dictionary
|
|
BGP parameters
|
|
|
always_compare_med
boolean
|
|
Always compare MEDs from different neighbors
|
|
|
bestpath
dictionary
|
|
Default bestpath selection mechanism
|
|
|
|
as_path
string
|
|
AS-path attribute comparison parameters
|
|
|
|
compare_routerid
boolean
|
|
Compare the router-id for identical EBGP paths
|
|
|
|
med
string
|
Choices:
- confed
- missing-as-worst
|
MED attribute comparison parameters
|
|
|
cluster_id
string
|
|
Route-reflector cluster-id
|
|
|
confederation
list
/ elements=dictionary
|
|
AS confederation parameters
|
|
|
|
identifier
integer
|
|
Confederation AS identifier
|
|
|
|
peers
integer
|
|
Peer ASs in the BGP confederation
|
|
|
dampening
dictionary
|
|
Enable route-flap dampening
|
|
|
|
half_life
integer
|
|
Half-life penalty in seconds
|
|
|
|
max_suppress_time
integer
|
|
Maximum duration to suppress a stable route
|
|
|
|
re_use
integer
|
|
Time to start reusing a route
|
|
|
|
start_suppress_time
integer
|
|
When to start suppressing a route
|
|
|
default
dictionary
|
|
BGP defaults
|
|
|
|
local_pref
integer
|
|
Default local preference
|
|
|
|
no_ipv4_unicast
boolean
|
|
Deactivate IPv4 unicast for a peer by default
Deprecated: Unavailable after 1.4
|
|
|
deterministic_med
boolean
|
|
Compare MEDs between different peers in the same AS
|
|
|
disable_network_import_check
boolean
|
|
Disable IGP route check for network statements
|
|
|
distance
list
/ elements=dictionary
|
|
Administrative distances for BGP routes
|
|
|
|
prefix
integer
|
|
Administrative distance for a specific BGP prefix
|
|
|
|
type
string
|
Choices:
- external
- internal
- local
|
Type of route
|
|
|
|
value
integer
|
|
distance
|
|
|
enforce_first_as
boolean
|
|
Require first AS in the path to match peer's AS
|
|
|
graceful_restart
integer
|
|
Maximum time to hold onto restarting peer's stale paths
|
|
|
log_neighbor_changes
boolean
|
|
Log neighbor up/down changes and reset reason
|
|
|
no_client_to_client_reflection
boolean
|
|
Disable client to client route reflection
|
|
|
no_fast_external_failover
boolean
|
|
Disable immediate session reset if peer's connected link goes down
|
|
|
router_id
string
|
|
BGP router-id
|
|
|
scan_time
integer
|
|
BGP route scanner interval
|
|
neighbor
list
/ elements=dictionary
|
|
BGP neighbor
|
|
|
address
string
|
|
BGP neighbor address (v4/v6).
|
|
|
advertisement_interval
integer
|
|
Minimum interval for sending routing updates.
|
|
|
capability
dictionary
|
|
Advertise capabilities to this neighbor.
|
|
|
|
dynamic
boolean
|
|
Advertise dynamic capability to this neighbor.
|
|
|
|
extended_nexthop
boolean
|
|
Advertise extended nexthop capability to this neighbor.
|
|
|
default_originate
string
|
|
Send default route to this neighbor
|
|
|
description
string
|
|
Description of the neighbor
|
|
|
disable_capability_negotiation
boolean
|
|
Disbale capability negotiation with the neighbor
|
|
|
disable_connected_check
boolean
|
|
Disable check to see if EBGP peer's address is a connected route.
|
|
|
disable_send_community
string
|
Choices:
- extended
- standard
|
Disable sending community attributes to this neighbor.
|
|
|
ebgp_multihop
integer
|
|
Allow this EBGP neighbor to not be on a directly connected network. Specify the number hops.
|
|
|
local_as
integer
|
|
local as number not to be prepended to updates from EBGP peers
|
|
|
override_capability
boolean
|
|
Ignore capability negotiation with specified neighbor.
|
|
|
passive
boolean
|
|
Do not initiate a session with this neighbor
|
|
|
password
string
|
|
BGP MD5 password
|
|
|
peer_group
boolean
|
|
True if all the configs under this neighbor key is for peer group template.
|
|
|
peer_group_name
string
|
|
IPv4 peer group for this peer
|
|
|
port
integer
|
|
Neighbor's BGP port
|
|
|
remote_as
integer
|
|
Neighbor BGP AS number
|
|
|
shutdown
boolean
|
|
Administratively shut down neighbor
|
|
|
solo
boolean
|
|
Do not send back prefixes learned from the neighbor
|
|
|
strict_capability_match
boolean
|
|
Enable strict capability negotiation
|
|
|
timers
dictionary
|
|
Neighbor timers
|
|
|
|
connect
integer
|
|
BGP connect timer for this neighbor.
|
|
|
|
holdtime
integer
|
|
BGP hold timer for this neighbor
|
|
|
|
keepalive
integer
|
|
BGP keepalive interval for this neighbor
|
|
|
ttl_security
integer
|
|
Number of the maximum number of hops to the BGP peer
|
|
|
update_source
string
|
|
Source IP of routing updates
|
|
timers
dictionary
|
|
BGP protocol timers
|
|
|
holdtime
integer
|
|
Hold time interval
|
|
|
keepalive
integer
|
|
Keepalive interval
|
|
running_config
string
|
|
This option is used only with state parsed.
The value of this option should be the output received from the EOS device by executing the command show running-config | section bgp.
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
|
|
state
string
|
Choices:
- deleted
merged ← - purged
- replaced
- gathered
- rendered
- parsed
|
The state the configuration should be left in.
State purged removes all the BGP configurations from the target device. Use caution with this state.('delete protocols bgp <x>')
State deleted only removes BGP attributes that this modules manages and does not negate the BGP process completely. Thereby, preserving address-family related configurations under BGP context.
Running states deleted and replaced will result in an error if there are address-family configuration lines present under neighbor context that is is to be removed. Please use the vyos.vyos.vyos_bgp_address_family module for prior cleanup.
Refer to examples for more details.
|