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

Choices:

Generate AS-set path information for this aggregate address.

prefix

string

BGP aggregate network.

summary_only

boolean

Choices:

Announce the aggregate summary network only.

as_number

integer

AS number.

bgp_params

dictionary

BGP parameters

always_compare_med

boolean

Choices:

Always compare MEDs from different neighbors

bestpath

dictionary

Default bestpath selection mechanism

as_path

string

Choices:

confed
ignore

AS-path attribute comparison parameters

compare_routerid

boolean

Choices:

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

Choices:

Deactivate IPv4 unicast for a peer by default

deterministic_med

boolean

Choices:

Compare MEDs between different peers in the same AS

disable_network_import_check

boolean

Choices:

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

Choices:

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

Choices:

Log neighbor up/down changes and reset reason

no_client_to_client_reflection

boolean

Choices:

Disable client to client route reflection

no_fast_external_failover

boolean

Choices:

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

integer

Number of occurrences of AS number.

as_override

boolean

Choices:

AS for routes sent to this neighbor to be the local AS.

attribute_unchanged

dictionary

BGP attributes are sent unchanged.

as_path

boolean

Choices:

as_path

med

boolean

Choices:

med

next_hop

boolean

Choices:

next_hop

capability

dictionary

Advertise capabilities to this neighbor.

dynamic

boolean

Choices:

Advertise dynamic capability to this neighbor.

orf

string

Choices:

send
receive

Advertise ORF capability to this neighbor.

default_originate

string

Send default route to this neighbor

description

string

description text

disable_capability_negotiation

boolean

Choices:

Disbale capability negotiation with the neighbor

disable_connected_check

boolean

Choices:

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.

distribute_list

list / elements=dictionary

Access-list to filter route updates to/from this neighbor.

acl

integer

Access-list number.

action

string

Choices:

export
import

Access-list to filter outgoing/incoming route updates to this neighbor

ebgp_multihop

integer

Allow this EBGP neighbor to not be on a directly connected network. Specify the number hops.

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

Choices:

Nexthop for routes sent to this neighbor to be the local router.

override_capability

boolean

Choices:

Ignore capability negotiation with specified neighbor.

passive

boolean

Choices:

Do not initiate a session with this neighbor

password

string

BGP MD5 password

peer_group

boolean

Choices:

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

Choices:

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

Choices:

Neighbor as a route reflector client

route_server_client

boolean

Choices:

Neighbor is route server client

shutdown

boolean

Choices:

Administratively shut down neighbor

soft_reconfiguration

boolean

Choices:

Soft reconfiguration for neighbor

strict_capability_match

boolean

Choices:

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

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

Choices:

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.

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		Choices: no yes	Generate AS-set path information for this aggregate address.
		prefix string			BGP aggregate network.
		summary_only boolean		Choices: no yes	Announce the aggregate summary network only.
	as_number integer				AS number.
	bgp_params dictionary				BGP parameters
		always_compare_med boolean		Choices: no yes	Always compare MEDs from different neighbors
		bestpath dictionary			Default bestpath selection mechanism
			as_path string	Choices: confed ignore	AS-path attribute comparison parameters
			compare_routerid boolean	Choices: no yes	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	Choices: no yes	Deactivate IPv4 unicast for a peer by default
		deterministic_med boolean		Choices: no yes	Compare MEDs between different peers in the same AS
		disable_network_import_check boolean		Choices: no yes	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		Choices: no yes	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		Choices: no yes	Log neighbor up/down changes and reset reason
		no_client_to_client_reflection boolean		Choices: no yes	Disable client to client route reflection
		no_fast_external_failover boolean		Choices: no yes	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 integer			Number of occurrences of AS number.
		as_override boolean		Choices: no yes	AS for routes sent to this neighbor to be the local AS.
		attribute_unchanged dictionary			BGP attributes are sent unchanged.
			as_path boolean	Choices: no yes	as_path
			med boolean	Choices: no yes	med
			next_hop boolean	Choices: no yes	next_hop
		capability dictionary			Advertise capabilities to this neighbor.
			dynamic boolean	Choices: no yes	Advertise dynamic capability to this neighbor.
			orf string	Choices: send receive	Advertise ORF capability to this neighbor.
		default_originate string			Send default route to this neighbor
		description string			description text
		disable_capability_negotiation boolean		Choices: no yes	Disbale capability negotiation with the neighbor
		disable_connected_check boolean		Choices: no yes	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.
		distribute_list list / elements=dictionary			Access-list to filter route updates to/from this neighbor.
			acl integer		Access-list number.
			action string	Choices: export import	Access-list to filter outgoing/incoming route updates to this neighbor
		ebgp_multihop integer			Allow this EBGP neighbor to not be on a directly connected network. Specify the number hops.
		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		Choices: no yes	Nexthop for routes sent to this neighbor to be the local router.
		override_capability boolean		Choices: no yes	Ignore capability negotiation with specified neighbor.
		passive boolean		Choices: no yes	Do not initiate a session with this neighbor
		password string			BGP MD5 password
		peer_group boolean		Choices: no yes	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		Choices: no yes	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		Choices: no yes	Neighbor as a route reflector client
		route_server_client boolean		Choices: no yes	Neighbor is route server client
		shutdown boolean		Choices: no yes	Administratively shut down neighbor
		soft_reconfiguration boolean		Choices: no yes	Soft reconfiguration for neighbor
		strict_capability_match boolean		Choices: no yes	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
		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		Choices: no yes	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.