| Parameter |
Choices/Defaults |
Comments |
|
config
dictionary
|
|
A dict of BGP global configuration for interfaces.
|
|
-
-
- aggregate_address
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- BGP aggregate network.
- |
-
-
- |
- |
-
-
- as_set
-
-
- boolean
-
- |
-
-
- |
-
- Generate AS-set path information for this aggregate address.
- |
-
-
- |
- |
-
-
- prefix
-
-
- string
-
- |
-
- |
-
- BGP aggregate network.
- |
-
-
- |
- |
-
-
- summary_only
-
-
- boolean
-
- |
-
-
- |
-
- Announce the aggregate summary network only.
- |
-
-
-
- |
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
+ 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
|
-
- |
-
-
- maximum_paths
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- BGP multipaths
- |
-
-
- |
- |
-
-
- count
-
-
- integer
-
- |
-
- |
-
- No. of paths.
- |
-
-
- |
- |
-
-
- path
-
-
- string
-
- |
-
- |
-
- BGP multipaths
- |
-
-
|
neighbor
list
/ elements=dictionary
|
|
BGP neighbor
|
|
|
address
string
|
|
BGP neighbor address (v4/v6).
|
|
|
advertisement_interval
integer
|
|
Minimum interval for sending routing updates.
|
|
|
- allowas_in
+ capability
- integer
+ dictionary
|
|
- Number of occurrences of AS number.
+ Advertise capabilities to this neighbor.
|
-
+
|
|
-
+ | |
+
- as_override
+ dynamic
boolean
|
|
- AS for routes sent to this neighbor to be the local AS.
+ Advertise dynamic capability to this neighbor.
|
|
|
-
-
- attribute_unchanged
-
-
- dictionary
-
- |
-
- |
-
- BGP attributes are sent unchanged.
- |
-
-
- |
- |
|
- as_path
+ extended_nexthop
boolean
|
|
- as_path
+ Advertise extended nexthop capability to this neighbor.
|
+
|
|
- |
-
+ |
- med
+ default_originate
- boolean
+ string
|
-
|
- med
+ Send default route to this neighbor
|
|
|
- |
-
+ |
- next_hop
+ description
- boolean
+ string
|
-
|
- next_hop
+ Description of the neighbor
|
-
|
|
- capability
+ disable_capability_negotiation
- dictionary
+ boolean
|
+
|
- Advertise capabilities to this neighbor.
+ Disbale capability negotiation with the neighbor
|
-
- |
+
|
|
-
+ |
- dynamic
+ disable_connected_check
boolean
|
|
- Advertise dynamic capability to this neighbor.
+ Disable check to see if EBGP peer's address is a connected route.
|
|
|
- |
-
+ |
- orf
+ disable_send_community
string
|
Choices:
- - send
- - receive
+ - extended
+ - standard
|
- Advertise ORF capability to this neighbor.
+ Disable sending community attributes to this neighbor.
|
-
|
|
- default_originate
+ ebgp_multihop
- string
+ integer
|
|
- Send default route to this neighbor
+ Allow this EBGP neighbor to not be on a directly connected network. Specify the number hops.
|
|
|
- description
+ local_as
- string
+ integer
|
|
- Description of the neighbor
+ local as number not to be prepended to updates from EBGP peers
|
|
|
- disable_capability_negotiation
+ override_capability
boolean
|
|
- Disbale capability negotiation with the neighbor
+ Ignore capability negotiation with specified neighbor.
|
|
|
- disable_connected_check
+ passive
boolean
|
|
- Disable check to see if EBGP peer's address is a connected route.
+ Do not initiate a session with this neighbor
|
|
|
- disable_send_community
+ password
string
|
- Choices:
- - extended
- - standard
-
|
- Disable sending community attributes to this neighbor.
+ BGP MD5 password
|
|
|
- distribute_list
+ peer_group
- list
- / elements=dictionary
+ boolean
|
+
|
- Access-list to filter route updates to/from this neighbor.
+ True if all the configs under this neighbor key is for peer group template.
|
-
- |
+
|
|
-
+ |
- acl
+ peer_group_name
- integer
+ string
|
|
- Access-list number.
+ IPv4 peer group for this peer
|
|
|
- |
-
+ |
- action
+ port
- string
+ integer
|
- Choices:
- - export
- - import
-
|
- Access-list to filter outgoing/incoming route updates to this neighbor
+ Neighbor's BGP port
|
-
|
|
- ebgp_multihop
+ remote_as
integer
|
|
- Allow this EBGP neighbor to not be on a directly connected network. Specify the number hops.
+ Neighbor BGP AS number
|
|
|
- filter_list
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- As-path-list to filter route updates to/from this neighbor.
- |
-
-
- |
- |
- |
-
-
- action
-
-
- string
-
- |
-
- Choices:
- - export
- - import
-
- |
-
- filter outgoing/incoming route updates
- |
-
-
- |
- |
- |
-
-
- path_list
-
-
- string
-
- |
-
- |
-
- As-path-list to filter
- |
-
-
-
- |
- |
-
-
- local_as
-
-
- integer
-
- |
-
- |
-
- local as number not to be prepended to updates from EBGP peers
- |
-
-
- |
- |
-
-
- maximum_prefix
-
-
- integer
-
- |
-
- |
-
- Maximum number of prefixes to accept from this neighbor nexthop-self Nexthop for routes sent to this neighbor to be the local router.
- |
-
-
- |
- |
-
-
- nexthop_self
-
-
- boolean
-
- |
-
-
- |
-
- Nexthop for routes sent to this neighbor to be the local router.
- |
-
-
- |
- |
-
-
- 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
- |
-
-
- |
- |
-
-
- prefix_list
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- Prefix-list to filter route updates to/from this neighbor.
- |
-
-
- |
- |
- |
-
-
- action
-
-
- string
-
- |
-
- Choices:
- - export
- - import
-
- |
-
- filter outgoing/incoming route updates
- |
-
-
- |
- |
- |
-
-
- prefix_list
-
-
- string
-
- |
-
- |
-
- Prefix-list to filter
- |
-
-
-
- |
- |
-
-
- remote_as
-
-
- integer
-
- |
-
- |
-
- Neighbor BGP AS number
- |
-
-
- |
- |
-
-
- remove_private_as
-
-
- boolean
-
- |
-
-
- |
-
- Remove private AS numbers from AS path in outbound route updates
- |
-
-
- |
- |
-
-
- route_map
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- Route-map to filter route updates to/from this neighbor.
- |
-
-
- |
- |
- |
-
-
- action
-
-
- string
-
- |
-
- Choices:
- - export
- - import
-
- |
-
- filter outgoing/incoming route updates
- |
-
-
- |
- |
- |
-
-
- route_map
-
-
- string
-
- |
-
- |
-
- route-map to filter
- |
-
-
-
- |
- |
-
-
- route_reflector_client
-
-
- boolean
-
- |
-
-
- |
-
- Neighbor as a route reflector client
- |
-
-
- |
- |
-
-
- route_server_client
-
-
- boolean
-
- |
-
-
- |
-
- Neighbor is route server client
- |
-
-
- |
- |
-
-
- shutdown
+ shutdown
boolean
|
|
Administratively shut down neighbor
|
|
|
- soft_reconfiguration
+ solo
boolean
|
|
- Soft reconfiguration for neighbor
+ 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
|
|
- Ttl security mechanism for this BGP peer
- |
-
-
- |
- |
-
-
- unsuppress_map
-
-
- string
-
- |
-
- |
-
- Route-map to selectively unsuppress suppressed routes
+ Number of the maximum number of hops to the BGP peer
|
|
|
update_source
string
|
|
Source IP of routing updates
|
-
- |
- |
-
-
- weight
-
-
- integer
-
- |
-
- |
-
- Default weight for routes from this neighbor
- |
-
-
-
- |
-
-
- network
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- BGP network
- |
-
-
- |
- |
-
-
- address
-
-
- string
-
- |
-
- |
-
- BGP network address
- |
-
-
- |
- |
-
-
- backdoor
-
-
- boolean
-
- |
-
-
- |
-
- Network as a backdoor route
- |
-
-
- |
- |
-
-
- route_map
-
-
- string
-
- |
-
- |
-
- Route-map to modify route attributes
- |
-
-
-
- |
-
-
- redistribute
-
-
- list
- / elements=dictionary
-
- |
-
- |
-
- Redistribute routes from other protocols into BGP
- |
-
-
- |
- |
-
-
- metric
-
-
- integer
-
- |
-
- |
-
- Metric for redistributed routes.
- |
-
-
- |
- |
-
-
- protocol
-
-
- string
-
- |
-
- Choices:
- - connected
- - kernel
- - ospf
- - rip
- - static
-
- |
-
- types of routes to be redistributed.
- |
-
-
- |
- |
-
-
- route_map
-
-
- string
-
- |
-
- |
-
- Route map to filter redistributed routes
- |
-
|
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.
|