source:	fortios_router_bgp.py
orphan:

fortios_router_bgp -- Configure BGP in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis
Requirements
Tips
FortiOS Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and bgp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_router_bgp	`v6.0.0 -> latest`

Parameters

access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
enable_log - Enable/Disable logging for task. type: bool required: false default: False
vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
member_path - Member attribute path to operate on. type: str
member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
router_bgp - Configure BGP. type: dict more...

Supported Version Ranges

router_bgp v6.0.0 -> latest

additional_path - Enable/disable selection of BGP IPv4 additional paths. type: str choices: enable, disable more...

Supported Version Ranges

additional_path v6.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path_select - Number of additional paths to be selected for each IPv4 NLRI. type: int more...

Supported Version Ranges

additional_path_select v6.2.0 -> latest
additional_path_select_vpnv4 - Number of additional paths to be selected for each VPNv4 NLRI. type: int more...

Supported Version Ranges

additional_path_select_vpnv4 v7.2.0 -> latest
additional_path_select6 - Number of additional paths to be selected for each IPv6 NLRI. type: int more...

Supported Version Ranges

additional_path_select6 v6.2.0 -> latest
additional_path_vpnv4 - Enable/disable selection of BGP VPNv4 additional paths. type: str choices: enable, disable more...

Supported Version Ranges

additional_path_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path6 - Enable/disable selection of BGP IPv6 additional paths. type: str choices: enable, disable more...

Supported Version Ranges

additional_path6 v6.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
admin_distance - Administrative distance modifications. type: list member_path: admin_distance:id more...

Supported Version Ranges

admin_distance v6.0.0 -> latest

distance - Administrative distance to apply (1 - 255). type: int more...

Supported Version Ranges

distance v6.0.0 -> latest
id - ID. see Notes. type: int required: true more...

Supported Version Ranges

id v6.0.0 -> latest
neighbour_prefix - Neighbor address prefix. type: str more...

Supported Version Ranges

neighbour_prefix v6.0.0 -> latest
route_list - Access list of routes to apply new distance to. Source router.access-list.name. type: str more...

Supported Version Ranges

route_list v6.0.0 -> latest

aggregate_address - BGP aggregate address table. type: list member_path: aggregate_address:id more...

Supported Version Ranges

aggregate_address v6.0.0 -> latest

as_set - Enable/disable generate AS set path information. type: str choices: enable, disable more...

Supported Version Ranges

as_set v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
id - ID. see Notes. type: int required: true more...

Supported Version Ranges

id v6.0.0 -> latest
prefix - Aggregate prefix. type: str more...

Supported Version Ranges

prefix v6.0.0 -> latest
summary_only - Enable/disable filter more specific routes from updates. type: str choices: enable, disable more...

Supported Version Ranges

summary_only v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

aggregate_address6 - BGP IPv6 aggregate address table. type: list member_path: aggregate_address6:id more...

Supported Version Ranges

aggregate_address6 v6.0.0 -> latest

as_set - Enable/disable generate AS set path information. type: str choices: enable, disable more...

Supported Version Ranges

as_set v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
id - ID. see Notes. type: int required: true more...

Supported Version Ranges

id v6.0.0 -> latest
prefix6 - Aggregate IPv6 prefix. type: str more...

Supported Version Ranges

prefix6 v6.0.0 -> latest
summary_only - Enable/disable filter more specific routes from updates. type: str choices: enable, disable more...

Supported Version Ranges

summary_only v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

always_compare_med - Enable/disable always compare MED. type: str choices: enable, disable more...

Supported Version Ranges

always_compare_med v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
as - Router AS number, asplain/asdot/asdot+ format, 0 to disable BGP. type: str more...

Supported Version Ranges

as v6.0.0 -> latest
bestpath_as_path_ignore - Enable/disable ignore AS path. type: str choices: enable, disable more...

Supported Version Ranges

bestpath_as_path_ignore v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
bestpath_cmp_confed_aspath - Enable/disable compare federation AS path length. type: str choices: enable, disable more...

Supported Version Ranges

bestpath_cmp_confed_aspath v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
bestpath_cmp_routerid - Enable/disable compare router ID for identical EBGP paths. type: str choices: enable, disable more...

Supported Version Ranges

bestpath_cmp_routerid v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
bestpath_med_confed - Enable/disable compare MED among confederation paths. type: str choices: enable, disable more...

Supported Version Ranges

bestpath_med_confed v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
bestpath_med_missing_as_worst - Enable/disable treat missing MED as least preferred. type: str choices: enable, disable more...

Supported Version Ranges

bestpath_med_missing_as_worst v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
client_to_client_reflection - Enable/disable client-to-client route reflection. type: str choices: enable, disable more...

Supported Version Ranges

client_to_client_reflection v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
cluster_id - Route reflector cluster ID. type: str more...

Supported Version Ranges

cluster_id v6.0.0 -> latest
confederation_identifier - Confederation identifier. type: int more...

Supported Version Ranges

confederation_identifier v6.0.0 -> latest
confederation_peers - Confederation peers. type: list member_path: confederation_peers:peer more...

Supported Version Ranges

confederation_peers v6.0.0 -> latest

peer - Peer ID. type: str required: true more...

Supported Version Ranges

peer v6.0.0 -> latest

cross_family_conditional_adv - Enable/disable cross address family conditional advertisement. type: str choices: enable, disable more...

Supported Version Ranges

cross_family_conditional_adv v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
dampening - Enable/disable route-flap dampening. type: str choices: enable, disable more...

Supported Version Ranges

dampening v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
dampening_max_suppress_time - Maximum minutes a route can be suppressed. type: int more...

Supported Version Ranges

dampening_max_suppress_time v6.0.0 -> latest
dampening_reachability_half_life - Reachability half-life time for penalty (min). type: int more...

Supported Version Ranges

dampening_reachability_half_life v6.0.0 -> latest
dampening_reuse - Threshold to reuse routes. type: int more...

Supported Version Ranges

dampening_reuse v6.0.0 -> latest
dampening_route_map - Criteria for dampening. Source router.route-map.name. type: str more...

Supported Version Ranges

dampening_route_map v6.0.0 -> latest
dampening_suppress - Threshold to suppress routes. type: int more...

Supported Version Ranges

dampening_suppress v6.0.0 -> latest
dampening_unreachability_half_life - Unreachability half-life time for penalty (min). type: int more...

Supported Version Ranges

dampening_unreachability_half_life v6.0.0 -> latest
default_local_preference - Default local preference. type: int more...

Supported Version Ranges

default_local_preference v6.0.0 -> latest
deterministic_med - Enable/disable enforce deterministic comparison of MED. type: str choices: enable, disable more...

Supported Version Ranges

deterministic_med v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
distance_external - Distance for routes external to the AS. type: int more...

Supported Version Ranges

distance_external v6.0.0 -> latest
distance_internal - Distance for routes internal to the AS. type: int more...

Supported Version Ranges

distance_internal v6.0.0 -> latest
distance_local - Distance for routes local to the AS. type: int more...

Supported Version Ranges

distance_local v6.0.0 -> latest
ebgp_multipath - Enable/disable EBGP multi-path. type: str choices: enable, disable more...

Supported Version Ranges

ebgp_multipath v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
enforce_first_as - Enable/disable enforce first AS for EBGP routes. type: str choices: enable, disable more...

Supported Version Ranges

enforce_first_as v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
fast_external_failover - Enable/disable reset peer BGP session if link goes down. type: str choices: enable, disable more...

Supported Version Ranges

fast_external_failover v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
graceful_end_on_timer - Enable/disable to exit graceful restart on timer only. type: str choices: enable, disable more...

Supported Version Ranges

graceful_end_on_timer v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
graceful_restart - Enable/disable BGP graceful restart capabilities. type: str choices: enable, disable more...

Supported Version Ranges

graceful_restart v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
graceful_restart_time - Time needed for neighbors to restart (sec). type: int more...

Supported Version Ranges

graceful_restart_time v6.0.0 -> latest
graceful_stalepath_time - Time to hold stale paths of restarting neighbor (sec). type: int more...

Supported Version Ranges

graceful_stalepath_time v6.0.0 -> latest
graceful_update_delay - Route advertisement/selection delay after restart (sec). type: int more...

Supported Version Ranges

graceful_update_delay v6.0.0 -> latest
holdtime_timer - Number of seconds to mark peer as dead. type: int more...

Supported Version Ranges

holdtime_timer v6.0.0 -> latest
ibgp_multipath - Enable/disable IBGP multi-path. type: str choices: enable, disable more...

Supported Version Ranges

ibgp_multipath v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
ignore_optional_capability - Do not send unknown optional capability notification message. type: str choices: enable, disable more...

Supported Version Ranges

ignore_optional_capability v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
keepalive_timer - Frequency to send keep alive requests. type: int more...

Supported Version Ranges

keepalive_timer v6.0.0 -> latest
log_neighbour_changes - Log BGP neighbor changes. type: str choices: enable, disable more...

Supported Version Ranges

log_neighbour_changes v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
multipath_recursive_distance - Enable/disable use of recursive distance to select multipath. type: str choices: enable, disable more...

Supported Version Ranges

multipath_recursive_distance v6.4.0 -> v6.4.0 v6.4.4 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
neighbor - BGP neighbor table. type: list member_path: neighbor:ip more...

Supported Version Ranges

neighbor v6.0.0 -> latest

activate - Enable/disable address family IPv4 for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
activate_evpn - Enable/disable address family L2VPN EVPN for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
activate_vpnv4 - Enable/disable address family VPNv4 for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
activate6 - Enable/disable address family IPv6 for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path - Enable/disable IPv4 additional-path capability. type: str choices: send, receive, both, disable more...

Supported Version Ranges

additional_path v6.2.0 -> latest

[send] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path_vpnv4 - Enable/disable VPNv4 additional-path capability. type: str choices: send, receive, both, disable more...

Supported Version Ranges

additional_path_vpnv4 v7.2.0 -> latest

[send] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path6 - Enable/disable IPv6 additional-path capability. type: str choices: send, receive, both, disable more...

Supported Version Ranges

additional_path6 v6.2.0 -> latest

[send] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
adv_additional_path - Number of IPv4 additional paths that can be advertised to this neighbor. type: int more...

Supported Version Ranges

adv_additional_path v6.2.0 -> latest
adv_additional_path_vpnv4 - Number of VPNv4 additional paths that can be advertised to this neighbor. type: int more...

Supported Version Ranges

adv_additional_path_vpnv4 v7.2.0 -> latest
adv_additional_path6 - Number of IPv6 additional paths that can be advertised to this neighbor. type: int more...

Supported Version Ranges

adv_additional_path6 v6.2.0 -> latest
advertisement_interval - Minimum interval (sec) between sending updates. type: int more...

Supported Version Ranges

advertisement_interval v6.0.0 -> latest
allowas_in - IPv4 The maximum number of occurrence of my AS number allowed. type: int more...

Supported Version Ranges

allowas_in v6.0.0 -> latest
allowas_in_enable - Enable/disable IPv4 Enable to allow my AS in AS path. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_enable_evpn - Enable/disable to allow my AS in AS path for L2VPN EVPN route. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_enable_vpnv4 - Enable/disable to allow my AS in AS path for VPNv4 route. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable_vpnv4 v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_enable6 - Enable/disable IPv6 Enable to allow my AS in AS path. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_evpn - The maximum number of occurrence of my AS number allowed for L2VPN EVPN route. type: int more...

Supported Version Ranges

allowas_in_evpn v7.4.0 -> latest
allowas_in_vpnv4 - The maximum number of occurrence of my AS number allowed for VPNv4 route. type: int more...

Supported Version Ranges

allowas_in_vpnv4 v7.2.0 -> latest
allowas_in6 - IPv6 The maximum number of occurrence of my AS number allowed. type: int more...

Supported Version Ranges

allowas_in6 v6.0.0 -> latest
as_override - Enable/disable replace peer AS with own AS for IPv4. type: str choices: enable, disable more...

Supported Version Ranges

as_override v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
as_override6 - Enable/disable replace peer AS with own AS for IPv6. type: str choices: enable, disable more...

Supported Version Ranges

as_override6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
attribute_unchanged - IPv4 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...

Supported Version Ranges

attribute_unchanged v6.0.0 -> latest

[as-path] v6.0.0 -> latest
[med] v6.0.0 -> latest
[next-hop] v6.0.0 -> latest
attribute_unchanged_vpnv4 - List of attributes that should be unchanged for VPNv4 route. type: list choices: as-path, med, next-hop more...

Supported Version Ranges

attribute_unchanged_vpnv4 v7.2.0 -> latest

[as-path] v6.0.0 -> latest
[med] v6.0.0 -> latest
[next-hop] v6.0.0 -> latest
attribute_unchanged6 - IPv6 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...

Supported Version Ranges

attribute_unchanged6 v6.0.0 -> latest

[as-path] v6.0.0 -> latest
[med] v6.0.0 -> latest
[next-hop] v6.0.0 -> latest
bfd - Enable/disable BFD for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

bfd v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_default_originate - Enable/disable advertise default IPv4 route to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_default_originate v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_default_originate6 - Enable/disable advertise default IPv6 route to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_default_originate6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_dynamic - Enable/disable advertise dynamic capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_dynamic v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart - Enable/disable advertise IPv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart_evpn - Enable/disable advertisement of L2VPN EVPN graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart_vpnv4 - Enable/disable advertise VPNv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart6 - Enable/disable advertise IPv6 graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_orf - Accept/Send IPv4 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...

Supported Version Ranges

capability_orf v6.0.0 -> latest

[none] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[send] v6.0.0 -> latest
[both] v6.0.0 -> latest
capability_orf6 - Accept/Send IPv6 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...

Supported Version Ranges

capability_orf6 v6.0.0 -> latest

[none] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[send] v6.0.0 -> latest
[both] v6.0.0 -> latest
capability_route_refresh - Enable/disable advertise route refresh capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_route_refresh v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
conditional_advertise - Conditional advertisement. type: list member_path: neighbor:ip/conditional_advertise:advertise_routemap more...

Supported Version Ranges

conditional_advertise v6.0.0 -> latest

advertise_routemap - Name of advertising route map. Source router.route-map.name. type: str required: true more...

Supported Version Ranges

advertise_routemap v6.0.0 -> latest
condition_routemap - List of conditional route maps. Source router.route-map.name. type: list member_path: neighbor:ip/conditional_advertise:advertise_routemap/condition_routemap:name more...

Supported Version Ranges

condition_routemap v6.0.0 -> latest

name - Route map. Source router.route-map.name. type: str required: true more...

Supported Version Ranges

name v7.0.4 -> latest

condition_type - Type of condition. type: str choices: exist, non-exist more...

Supported Version Ranges

condition_type v6.0.0 -> latest

[exist] v6.0.0 -> latest
[non-exist] v6.0.0 -> latest

conditional_advertise6 - IPv6 conditional advertisement. type: list member_path: neighbor:ip/conditional_advertise6:advertise_routemap more...

Supported Version Ranges

conditional_advertise6 v7.0.1 -> latest

advertise_routemap - Name of advertising route map. Source router.route-map.name. type: str required: true more...

Supported Version Ranges

advertise_routemap v7.0.1 -> latest
condition_routemap - List of conditional route maps. Source router.route-map.name. type: list member_path: neighbor:ip/conditional_advertise6:advertise_routemap/condition_routemap:name more...

Supported Version Ranges

condition_routemap v7.0.1 -> latest

name - Route map. Source router.route-map.name. type: str required: true more...

Supported Version Ranges

name v7.0.4 -> latest

condition_type - Type of condition. type: str choices: exist, non-exist more...

Supported Version Ranges

condition_type v7.0.1 -> latest

[exist] v6.0.0 -> latest
[non-exist] v6.0.0 -> latest

connect_timer - Interval (sec) for connect timer. type: int more...

Supported Version Ranges

connect_timer v6.0.0 -> latest
default_originate_routemap - Route map to specify criteria to originate IPv4 default. Source router.route-map.name. type: str more...

Supported Version Ranges

default_originate_routemap v6.0.0 -> latest
default_originate_routemap6 - Route map to specify criteria to originate IPv6 default. Source router.route-map.name. type: str more...

Supported Version Ranges

default_originate_routemap6 v6.0.0 -> latest
description - Description. type: str more...

Supported Version Ranges

description v6.0.0 -> latest
distribute_list_in - Filter for IPv4 updates from this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_in v6.0.0 -> latest
distribute_list_in_vpnv4 - Filter for VPNv4 updates from this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_in_vpnv4 v7.2.0 -> latest
distribute_list_in6 - Filter for IPv6 updates from this neighbor. Source router.access-list6.name. type: str more...

Supported Version Ranges

distribute_list_in6 v6.0.0 -> latest
distribute_list_out - Filter for IPv4 updates to this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_out v6.0.0 -> latest
distribute_list_out_vpnv4 - Filter for VPNv4 updates to this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_out_vpnv4 v7.2.0 -> latest
distribute_list_out6 - Filter for IPv6 updates to this neighbor. Source router.access-list6.name. type: str more...

Supported Version Ranges

distribute_list_out6 v6.0.0 -> latest
dont_capability_negotiate - Do not negotiate capabilities with this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

dont_capability_negotiate v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
ebgp_enforce_multihop - Enable/disable allow multi-hop EBGP neighbors. type: str choices: enable, disable more...

Supported Version Ranges

ebgp_enforce_multihop v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
ebgp_multihop_ttl - EBGP multihop TTL for this peer. type: int more...

Supported Version Ranges

ebgp_multihop_ttl v6.0.0 -> latest
filter_list_in - BGP filter for IPv4 inbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_in v6.0.0 -> latest
filter_list_in_vpnv4 - BGP filter for VPNv4 inbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_in_vpnv4 v7.4.1 -> latest
filter_list_in6 - BGP filter for IPv6 inbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_in6 v6.0.0 -> latest
filter_list_out - BGP filter for IPv4 outbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_out v6.0.0 -> latest
filter_list_out_vpnv4 - BGP filter for VPNv4 outbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_out_vpnv4 v7.4.1 -> latest
filter_list_out6 - BGP filter for IPv6 outbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_out6 v6.0.0 -> latest
holdtime_timer - Interval (sec) before peer considered dead. type: int more...

Supported Version Ranges

holdtime_timer v6.0.0 -> latest
interface - Specify outgoing interface for peer connection. For IPv6 peer, the interface should have link-local address. Source system .interface.name. type: str more...

Supported Version Ranges

interface v6.0.0 -> latest
ip - IP/IPv6 address of neighbor. type: str required: true more...

Supported Version Ranges

ip v6.0.0 -> latest
keep_alive_timer - Keep alive timer interval (sec). type: int more...

Supported Version Ranges

keep_alive_timer v6.0.0 -> latest
link_down_failover - Enable/disable failover upon link down. type: str choices: enable, disable more...

Supported Version Ranges

link_down_failover v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
local_as - Local AS number of neighbor. type: str more...

Supported Version Ranges

local_as v6.0.0 -> latest
local_as_no_prepend - Do not prepend local-as to incoming updates. type: str choices: enable, disable more...

Supported Version Ranges

local_as_no_prepend v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
local_as_replace_as - Replace real AS with local-as in outgoing updates. type: str choices: enable, disable more...

Supported Version Ranges

local_as_replace_as v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix - Maximum number of IPv4 prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix v6.0.0 -> latest
maximum_prefix_evpn - Maximum number of L2VPN EVPN prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix_evpn v7.4.0 -> latest
maximum_prefix_threshold - Maximum IPv4 prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold v6.0.0 -> latest
maximum_prefix_threshold_evpn - Maximum L2VPN EVPN prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold_evpn v7.4.0 -> latest
maximum_prefix_threshold_vpnv4 - Maximum VPNv4 prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold_vpnv4 v7.2.0 -> latest
maximum_prefix_threshold6 - Maximum IPv6 prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold6 v6.0.0 -> latest
maximum_prefix_vpnv4 - Maximum number of VPNv4 prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix_vpnv4 v7.2.0 -> latest
maximum_prefix_warning_only - Enable/disable IPv4 Only give warning message when limit is exceeded. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix_warning_only_evpn - Enable/disable only sending warning message when exceeding limit of L2VPN EVPN routes. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix_warning_only_vpnv4 - Enable/disable only giving warning message when limit is exceeded for VPNv4 routes. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix_warning_only6 - Enable/disable IPv6 Only give warning message when limit is exceeded. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix6 - Maximum number of IPv6 prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix6 v6.0.0 -> latest
next_hop_self - Enable/disable IPv4 next-hop calculation for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self_rr - Enable/disable setting nexthop"s address to interface"s IPv4 address for route-reflector routes. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self_rr v6.4.4 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self_rr6 - Enable/disable setting nexthop"s address to interface"s IPv6 address for route-reflector routes. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self_rr6 v6.4.4 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self_vpnv4 - Enable/disable setting VPNv4 next-hop to interface"s IP address for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self6 - Enable/disable IPv6 next-hop calculation for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
override_capability - Enable/disable override result of capability negotiation. type: str choices: enable, disable more...

Supported Version Ranges

override_capability v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
passive - Enable/disable sending of open messages to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

passive v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
password - Password used in MD5 authentication. type: str more...

Supported Version Ranges

password v6.0.0 -> latest
prefix_list_in - IPv4 Inbound filter for updates from this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_in v6.0.0 -> latest
prefix_list_in_vpnv4 - Inbound filter for VPNv4 updates from this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_in_vpnv4 v7.2.0 -> latest
prefix_list_in6 - IPv6 Inbound filter for updates from this neighbor. Source router.prefix-list6.name. type: str more...

Supported Version Ranges

prefix_list_in6 v6.0.0 -> latest
prefix_list_out - IPv4 Outbound filter for updates to this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_out v6.0.0 -> latest
prefix_list_out_vpnv4 - Outbound filter for VPNv4 updates to this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_out_vpnv4 v7.2.0 -> latest
prefix_list_out6 - IPv6 Outbound filter for updates to this neighbor. Source router.prefix-list6.name. type: str more...

Supported Version Ranges

prefix_list_out6 v6.0.0 -> latest
remote_as - AS number of neighbor. type: str more...

Supported Version Ranges

remote_as v6.0.0 -> latest
remove_private_as - Enable/disable remove private AS number from IPv4 outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
remove_private_as_evpn - Enable/disable removing private AS number from L2VPN EVPN outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
remove_private_as_vpnv4 - Enable/disable remove private AS number from VPNv4 outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
remove_private_as6 - Enable/disable remove private AS number from IPv6 outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
restart_time - Graceful restart delay time (sec, 0 = global default). type: int more...

Supported Version Ranges

restart_time v6.0.0 -> latest
retain_stale_time - Time to retain stale routes. type: int more...

Supported Version Ranges

retain_stale_time v6.0.0 -> latest
route_map_in - IPv4 Inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in v6.0.0 -> latest
route_map_in_evpn - L2VPN EVPN inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in_evpn v7.4.0 -> latest
route_map_in_vpnv4 - VPNv4 inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in_vpnv4 v7.2.0 -> latest
route_map_in6 - IPv6 Inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in6 v6.0.0 -> latest
route_map_out - IPv4 outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out v6.0.0 -> latest
route_map_out_evpn - L2VPN EVPN outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_evpn v7.4.0 -> latest
route_map_out_preferable - IPv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_preferable v6.2.0 -> latest
route_map_out_vpnv4 - VPNv4 outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_vpnv4 v7.2.0 -> latest
route_map_out_vpnv4_preferable - VPNv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_vpnv4_preferable v7.2.0 -> latest
route_map_out6 - IPv6 Outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out6 v6.0.0 -> latest
route_map_out6_preferable - IPv6 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out6_preferable v6.2.0 -> latest
route_reflector_client - Enable/disable IPv4 AS route reflector client. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_reflector_client_evpn - Enable/disable L2VPN EVPN AS route reflector client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_reflector_client_vpnv4 - Enable/disable VPNv4 AS route reflector client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_reflector_client6 - Enable/disable IPv6 AS route reflector client. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client - Enable/disable IPv4 AS route server client. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client_evpn - Enable/disable L2VPN EVPN AS route server client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client_vpnv4 - Enable/disable VPNv4 AS route server client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client6 - Enable/disable IPv6 AS route server client. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community - IPv4 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community v6.0.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community_evpn - Enable/disable sending community attribute to neighbor for L2VPN EVPN address family. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community_evpn v7.4.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community_vpnv4 - Send community attribute to neighbor for VPNv4 address family. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community_vpnv4 v7.2.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community6 - IPv6 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community6 v6.0.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
shutdown - Enable/disable shutdown this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

shutdown v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration - Enable/disable allow IPv4 inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration_evpn - Enable/disable L2VPN EVPN inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration_vpnv4 - Enable/disable allow VPNv4 inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration6 - Enable/disable allow IPv6 inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
stale_route - Enable/disable stale route after neighbor down. type: str choices: enable, disable more...

Supported Version Ranges

stale_route v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
strict_capability_match - Enable/disable strict capability matching. type: str choices: enable, disable more...

Supported Version Ranges

strict_capability_match v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
unsuppress_map - IPv4 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...

Supported Version Ranges

unsuppress_map v6.0.0 -> latest
unsuppress_map6 - IPv6 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...

Supported Version Ranges

unsuppress_map6 v6.0.0 -> latest
update_source - Interface to use as source IP/IPv6 address of TCP connections. Source system.interface.name. type: str more...

Supported Version Ranges

update_source v6.0.0 -> latest
weight - Neighbor weight. type: int more...

Supported Version Ranges

weight v6.0.0 -> latest

neighbor_group - BGP neighbor group table. type: list member_path: neighbor_group:name more...

Supported Version Ranges

neighbor_group v6.0.0 -> latest

activate - Enable/disable address family IPv4 for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
activate_evpn - Enable/disable address family L2VPN EVPN for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
activate_vpnv4 - Enable/disable address family VPNv4 for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
activate6 - Enable/disable address family IPv6 for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

activate6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path - Enable/disable IPv4 additional-path capability. type: str choices: send, receive, both, disable more...

Supported Version Ranges

additional_path v6.2.0 -> latest

[send] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path_vpnv4 - Enable/disable VPNv4 additional-path capability. type: str choices: send, receive, both, disable more...

Supported Version Ranges

additional_path_vpnv4 v7.2.0 -> latest

[send] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
additional_path6 - Enable/disable IPv6 additional-path capability. type: str choices: send, receive, both, disable more...

Supported Version Ranges

additional_path6 v6.2.0 -> latest

[send] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
adv_additional_path - Number of IPv4 additional paths that can be advertised to this neighbor. type: int more...

Supported Version Ranges

adv_additional_path v6.2.0 -> latest
adv_additional_path_vpnv4 - Number of VPNv4 additional paths that can be advertised to this neighbor. type: int more...

Supported Version Ranges

adv_additional_path_vpnv4 v7.2.0 -> latest
adv_additional_path6 - Number of IPv6 additional paths that can be advertised to this neighbor. type: int more...

Supported Version Ranges

adv_additional_path6 v6.2.0 -> latest
advertisement_interval - Minimum interval (sec) between sending updates. type: int more...

Supported Version Ranges

advertisement_interval v6.0.0 -> latest
allowas_in - IPv4 The maximum number of occurrence of my AS number allowed. type: int more...

Supported Version Ranges

allowas_in v6.0.0 -> latest
allowas_in_enable - Enable/disable IPv4 Enable to allow my AS in AS path. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_enable_evpn - Enable/disable to allow my AS in AS path for L2VPN EVPN route. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_enable_vpnv4 - Enable/disable to allow my AS in AS path for VPNv4 route. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable_vpnv4 v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_enable6 - Enable/disable IPv6 Enable to allow my AS in AS path. type: str choices: enable, disable more...

Supported Version Ranges

allowas_in_enable6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
allowas_in_evpn - The maximum number of occurrence of my AS number allowed for L2VPN EVPN route. type: int more...

Supported Version Ranges

allowas_in_evpn v7.4.0 -> latest
allowas_in_vpnv4 - The maximum number of occurrence of my AS number allowed for VPNv4 route. type: int more...

Supported Version Ranges

allowas_in_vpnv4 v7.2.0 -> latest
allowas_in6 - IPv6 The maximum number of occurrence of my AS number allowed. type: int more...

Supported Version Ranges

allowas_in6 v6.0.0 -> latest
as_override - Enable/disable replace peer AS with own AS for IPv4. type: str choices: enable, disable more...

Supported Version Ranges

as_override v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
as_override6 - Enable/disable replace peer AS with own AS for IPv6. type: str choices: enable, disable more...

Supported Version Ranges

as_override6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
attribute_unchanged - IPv4 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...

Supported Version Ranges

attribute_unchanged v6.0.0 -> latest

[as-path] v6.0.0 -> latest
[med] v6.0.0 -> latest
[next-hop] v6.0.0 -> latest
attribute_unchanged_vpnv4 - List of attributes that should be unchanged for VPNv4 route. type: list choices: as-path, med, next-hop more...

Supported Version Ranges

attribute_unchanged_vpnv4 v7.2.0 -> latest

[as-path] v6.0.0 -> latest
[med] v6.0.0 -> latest
[next-hop] v6.0.0 -> latest
attribute_unchanged6 - IPv6 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...

Supported Version Ranges

attribute_unchanged6 v6.0.0 -> latest

[as-path] v6.0.0 -> latest
[med] v6.0.0 -> latest
[next-hop] v6.0.0 -> latest
bfd - Enable/disable BFD for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

bfd v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_default_originate - Enable/disable advertise default IPv4 route to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_default_originate v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_default_originate6 - Enable/disable advertise default IPv6 route to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_default_originate6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_dynamic - Enable/disable advertise dynamic capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_dynamic v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart - Enable/disable advertise IPv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart_evpn - Enable/disable advertisement of L2VPN EVPN graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart_vpnv4 - Enable/disable advertise VPNv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_graceful_restart6 - Enable/disable advertise IPv6 graceful restart capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_graceful_restart6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
capability_orf - Accept/Send IPv4 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...

Supported Version Ranges

capability_orf v6.0.0 -> latest

[none] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[send] v6.0.0 -> latest
[both] v6.0.0 -> latest
capability_orf6 - Accept/Send IPv6 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...

Supported Version Ranges

capability_orf6 v6.0.0 -> latest

[none] v6.0.0 -> latest
[receive] v6.0.0 -> latest
[send] v6.0.0 -> latest
[both] v6.0.0 -> latest
capability_route_refresh - Enable/disable advertise route refresh capability to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

capability_route_refresh v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
connect_timer - Interval (sec) for connect timer. type: int more...

Supported Version Ranges

connect_timer v6.0.0 -> latest
default_originate_routemap - Route map to specify criteria to originate IPv4 default. Source router.route-map.name. type: str more...

Supported Version Ranges

default_originate_routemap v6.0.0 -> latest
default_originate_routemap6 - Route map to specify criteria to originate IPv6 default. Source router.route-map.name. type: str more...

Supported Version Ranges

default_originate_routemap6 v6.0.0 -> latest
description - Description. type: str more...

Supported Version Ranges

description v6.0.0 -> latest
distribute_list_in - Filter for IPv4 updates from this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_in v6.0.0 -> latest
distribute_list_in_vpnv4 - Filter for VPNv4 updates from this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_in_vpnv4 v7.2.0 -> latest
distribute_list_in6 - Filter for IPv6 updates from this neighbor. Source router.access-list6.name. type: str more...

Supported Version Ranges

distribute_list_in6 v6.0.0 -> latest
distribute_list_out - Filter for IPv4 updates to this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_out v6.0.0 -> latest
distribute_list_out_vpnv4 - Filter for VPNv4 updates to this neighbor. Source router.access-list.name. type: str more...

Supported Version Ranges

distribute_list_out_vpnv4 v7.2.0 -> latest
distribute_list_out6 - Filter for IPv6 updates to this neighbor. Source router.access-list6.name. type: str more...

Supported Version Ranges

distribute_list_out6 v6.0.0 -> latest
dont_capability_negotiate - Do not negotiate capabilities with this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

dont_capability_negotiate v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
ebgp_enforce_multihop - Enable/disable allow multi-hop EBGP neighbors. type: str choices: enable, disable more...

Supported Version Ranges

ebgp_enforce_multihop v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
ebgp_multihop_ttl - EBGP multihop TTL for this peer. type: int more...

Supported Version Ranges

ebgp_multihop_ttl v6.0.0 -> latest
filter_list_in - BGP filter for IPv4 inbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_in v6.0.0 -> latest
filter_list_in_vpnv4 - BGP filter for VPNv4 inbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_in_vpnv4 v7.4.1 -> latest
filter_list_in6 - BGP filter for IPv6 inbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_in6 v6.0.0 -> latest
filter_list_out - BGP filter for IPv4 outbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_out v6.0.0 -> latest
filter_list_out_vpnv4 - BGP filter for VPNv4 outbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_out_vpnv4 v7.4.1 -> latest
filter_list_out6 - BGP filter for IPv6 outbound routes. Source router.aspath-list.name. type: str more...

Supported Version Ranges

filter_list_out6 v6.0.0 -> latest
holdtime_timer - Interval (sec) before peer considered dead. type: int more...

Supported Version Ranges

holdtime_timer v6.0.0 -> latest
interface - Specify outgoing interface for peer connection. For IPv6 peer, the interface should have link-local address. Source system .interface.name. type: str more...

Supported Version Ranges

interface v6.0.0 -> latest
keep_alive_timer - Keep alive timer interval (sec). type: int more...

Supported Version Ranges

keep_alive_timer v6.0.0 -> latest
link_down_failover - Enable/disable failover upon link down. type: str choices: enable, disable more...

Supported Version Ranges

link_down_failover v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
local_as - Local AS number of neighbor. type: str more...

Supported Version Ranges

local_as v6.0.0 -> latest
local_as_no_prepend - Do not prepend local-as to incoming updates. type: str choices: enable, disable more...

Supported Version Ranges

local_as_no_prepend v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
local_as_replace_as - Replace real AS with local-as in outgoing updates. type: str choices: enable, disable more...

Supported Version Ranges

local_as_replace_as v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix - Maximum number of IPv4 prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix v6.0.0 -> latest
maximum_prefix_evpn - Maximum number of L2VPN EVPN prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix_evpn v7.4.0 -> latest
maximum_prefix_threshold - Maximum IPv4 prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold v6.0.0 -> latest
maximum_prefix_threshold_evpn - Maximum L2VPN EVPN prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold_evpn v7.4.0 -> latest
maximum_prefix_threshold_vpnv4 - Maximum VPNv4 prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold_vpnv4 v7.2.0 -> latest
maximum_prefix_threshold6 - Maximum IPv6 prefix threshold value (1 - 100 percent). type: int more...

Supported Version Ranges

maximum_prefix_threshold6 v6.0.0 -> latest
maximum_prefix_vpnv4 - Maximum number of VPNv4 prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix_vpnv4 v7.2.0 -> latest
maximum_prefix_warning_only - Enable/disable IPv4 Only give warning message when limit is exceeded. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix_warning_only_evpn - Enable/disable only sending warning message when exceeding limit of L2VPN EVPN routes. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix_warning_only_vpnv4 - Enable/disable only giving warning message when limit is exceeded for VPNv4 routes. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix_warning_only6 - Enable/disable IPv6 Only give warning message when limit is exceeded. type: str choices: enable, disable more...

Supported Version Ranges

maximum_prefix_warning_only6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
maximum_prefix6 - Maximum number of IPv6 prefixes to accept from this peer. type: int more...

Supported Version Ranges

maximum_prefix6 v6.0.0 -> latest
name - Neighbor group name. type: str required: true more...

Supported Version Ranges

name v6.0.0 -> latest
next_hop_self - Enable/disable IPv4 next-hop calculation for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self_rr - Enable/disable setting nexthop"s address to interface"s IPv4 address for route-reflector routes. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self_rr v6.4.4 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self_rr6 - Enable/disable setting nexthop"s address to interface"s IPv6 address for route-reflector routes. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self_rr6 v6.4.4 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self_vpnv4 - Enable/disable setting VPNv4 next-hop to interface"s IP address for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
next_hop_self6 - Enable/disable IPv6 next-hop calculation for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

next_hop_self6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
override_capability - Enable/disable override result of capability negotiation. type: str choices: enable, disable more...

Supported Version Ranges

override_capability v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
passive - Enable/disable sending of open messages to this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

passive v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
password - Password used in MD5 authentication. type: str more...

Supported Version Ranges

password v7.2.4 -> latest
prefix_list_in - IPv4 Inbound filter for updates from this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_in v6.0.0 -> latest
prefix_list_in_vpnv4 - Inbound filter for VPNv4 updates from this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_in_vpnv4 v7.2.0 -> latest
prefix_list_in6 - IPv6 Inbound filter for updates from this neighbor. Source router.prefix-list6.name. type: str more...

Supported Version Ranges

prefix_list_in6 v6.0.0 -> latest
prefix_list_out - IPv4 Outbound filter for updates to this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_out v6.0.0 -> latest
prefix_list_out_vpnv4 - Outbound filter for VPNv4 updates to this neighbor. Source router.prefix-list.name. type: str more...

Supported Version Ranges

prefix_list_out_vpnv4 v7.2.0 -> latest
prefix_list_out6 - IPv6 Outbound filter for updates to this neighbor. Source router.prefix-list6.name. type: str more...

Supported Version Ranges

prefix_list_out6 v6.0.0 -> latest
remote_as - AS number of neighbor. type: str more...

Supported Version Ranges

remote_as v6.0.0 -> latest
remove_private_as - Enable/disable remove private AS number from IPv4 outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
remove_private_as_evpn - Enable/disable removing private AS number from L2VPN EVPN outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
remove_private_as_vpnv4 - Enable/disable remove private AS number from VPNv4 outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
remove_private_as6 - Enable/disable remove private AS number from IPv6 outbound updates. type: str choices: enable, disable more...

Supported Version Ranges

remove_private_as6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
restart_time - Graceful restart delay time (sec, 0 = global default). type: int more...

Supported Version Ranges

restart_time v6.0.0 -> latest
retain_stale_time - Time to retain stale routes. type: int more...

Supported Version Ranges

retain_stale_time v6.0.0 -> latest
route_map_in - IPv4 Inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in v6.0.0 -> latest
route_map_in_evpn - L2VPN EVPN inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in_evpn v7.4.0 -> latest
route_map_in_vpnv4 - VPNv4 inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in_vpnv4 v7.2.0 -> latest
route_map_in6 - IPv6 Inbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_in6 v6.0.0 -> latest
route_map_out - IPv4 outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out v6.0.0 -> latest
route_map_out_evpn - L2VPN EVPN outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_evpn v7.4.0 -> latest
route_map_out_preferable - IPv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_preferable v6.2.0 -> latest
route_map_out_vpnv4 - VPNv4 outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_vpnv4 v7.2.0 -> latest
route_map_out_vpnv4_preferable - VPNv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out_vpnv4_preferable v7.2.0 -> latest
route_map_out6 - IPv6 Outbound route map filter. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out6 v6.0.0 -> latest
route_map_out6_preferable - IPv6 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map_out6_preferable v6.2.0 -> latest
route_reflector_client - Enable/disable IPv4 AS route reflector client. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_reflector_client_evpn - Enable/disable L2VPN EVPN AS route reflector client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_reflector_client_vpnv4 - Enable/disable VPNv4 AS route reflector client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_reflector_client6 - Enable/disable IPv6 AS route reflector client. type: str choices: enable, disable more...

Supported Version Ranges

route_reflector_client6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client - Enable/disable IPv4 AS route server client. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client_evpn - Enable/disable L2VPN EVPN AS route server client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client_vpnv4 - Enable/disable VPNv4 AS route server client for this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
route_server_client6 - Enable/disable IPv6 AS route server client. type: str choices: enable, disable more...

Supported Version Ranges

route_server_client6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community - IPv4 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community v6.0.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community_evpn - Enable/disable sending community attribute to neighbor for L2VPN EVPN address family. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community_evpn v7.4.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community_vpnv4 - Send community attribute to neighbor for VPNv4 address family. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community_vpnv4 v7.2.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
send_community6 - IPv6 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...

Supported Version Ranges

send_community6 v6.0.0 -> latest

[standard] v6.0.0 -> latest
[extended] v6.0.0 -> latest
[both] v6.0.0 -> latest
[disable] v6.0.0 -> latest
shutdown - Enable/disable shutdown this neighbor. type: str choices: enable, disable more...

Supported Version Ranges

shutdown v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration - Enable/disable allow IPv4 inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration_evpn - Enable/disable L2VPN EVPN inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration_evpn v7.4.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration_vpnv4 - Enable/disable allow VPNv4 inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration_vpnv4 v7.2.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
soft_reconfiguration6 - Enable/disable allow IPv6 inbound soft reconfiguration. type: str choices: enable, disable more...

Supported Version Ranges

soft_reconfiguration6 v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
stale_route - Enable/disable stale route after neighbor down. type: str choices: enable, disable more...

Supported Version Ranges

stale_route v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
strict_capability_match - Enable/disable strict capability matching. type: str choices: enable, disable more...

Supported Version Ranges

strict_capability_match v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
unsuppress_map - IPv4 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...

Supported Version Ranges

unsuppress_map v6.0.0 -> latest
unsuppress_map6 - IPv6 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...

Supported Version Ranges

unsuppress_map6 v6.0.0 -> latest
update_source - Interface to use as source IP/IPv6 address of TCP connections. Source system.interface.name. type: str more...

Supported Version Ranges

update_source v6.0.0 -> latest
weight - Neighbor weight. type: int more...

Supported Version Ranges

weight v6.0.0 -> latest

neighbor_range - BGP neighbor range table. type: list member_path: neighbor_range:id more...

Supported Version Ranges

neighbor_range v6.0.0 -> latest

id - Neighbor range ID. see Notes. type: int required: true more...

Supported Version Ranges

id v6.0.0 -> latest
max_neighbor_num - Maximum number of neighbors. type: int more...

Supported Version Ranges

max_neighbor_num v6.0.0 -> latest
neighbor_group - Neighbor group name. Source router.bgp.neighbor-group.name. type: str more...

Supported Version Ranges

neighbor_group v6.0.0 -> latest
prefix - Neighbor range prefix. type: str more...

Supported Version Ranges

prefix v6.0.0 -> latest

neighbor_range6 - BGP IPv6 neighbor range table. type: list member_path: neighbor_range6:id more...

Supported Version Ranges

neighbor_range6 v6.0.0 -> latest

id - IPv6 neighbor range ID. see Notes. type: int required: true more...

Supported Version Ranges

id v6.0.0 -> latest
max_neighbor_num - Maximum number of neighbors. type: int more...

Supported Version Ranges

max_neighbor_num v6.0.0 -> latest
neighbor_group - Neighbor group name. Source router.bgp.neighbor-group.name. type: str more...

Supported Version Ranges

neighbor_group v6.0.0 -> latest
prefix6 - IPv6 prefix. type: str more...

Supported Version Ranges

prefix6 v6.0.0 -> latest

network - BGP network table. type: list member_path: network:id more...

Supported Version Ranges

network v6.0.0 -> latest

backdoor - Enable/disable route as backdoor. type: str choices: enable, disable more...

Supported Version Ranges

backdoor v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
id - ID. see Notes. type: int required: true more...

Supported Version Ranges

id v6.0.0 -> latest
network_import_check - Configure insurance of BGP network route existence in IGP. type: str choices: global, enable, disable more...

Supported Version Ranges

network_import_check v7.0.4 -> latest

[global] v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
prefix - Network prefix. type: str more...

Supported Version Ranges

prefix v6.0.0 -> latest
route_map - Route map to modify generated route. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v6.0.0 -> latest

network_import_check - Enable/disable ensure BGP network route exists in IGP. type: str choices: enable, disable more...

Supported Version Ranges

network_import_check v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
network6 - BGP IPv6 network table. type: list member_path: network6:id more...

Supported Version Ranges

network6 v6.0.0 -> latest

backdoor - Enable/disable route as backdoor. type: str choices: enable, disable more...

Supported Version Ranges

backdoor v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
id - ID. see Notes. type: int required: true more...

Supported Version Ranges

id v6.0.0 -> latest
network_import_check - Configure insurance of BGP network route existence in IGP. type: str choices: global, enable, disable more...

Supported Version Ranges

network_import_check v7.0.4 -> latest

[global] v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
prefix6 - Network IPv6 prefix. type: str more...

Supported Version Ranges

prefix6 v6.0.0 -> latest
route_map - Route map to modify generated route. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v6.0.0 -> latest

recursive_inherit_priority - Enable/disable priority inheritance for recursive resolution. type: str choices: enable, disable more...

Supported Version Ranges

recursive_inherit_priority v7.2.1 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
recursive_next_hop - Enable/disable recursive resolution of next-hop using BGP route. type: str choices: enable, disable more...

Supported Version Ranges

recursive_next_hop v7.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
redistribute - BGP IPv4 redistribute table. type: list member_path: redistribute:name more...

Supported Version Ranges

redistribute v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0

name - Distribute list entry name. type: str required: true more...

Supported Version Ranges

name v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
route_map - Route map name. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
status - Status. type: str choices: enable, disable more...

Supported Version Ranges

status v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

redistribute6 - BGP IPv6 redistribute table. type: list member_path: redistribute6:name more...

Supported Version Ranges

redistribute6 v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0

name - Distribute list entry name. type: str required: true more...

Supported Version Ranges

name v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
route_map - Route map name. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0
status - Status. type: str choices: enable, disable more...

Supported Version Ranges

status v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

router_id - Router ID. type: str more...

Supported Version Ranges

router_id v6.0.0 -> latest
scan_time - Background scanner interval (sec), 0 to disable it. type: int more...

Supported Version Ranges

scan_time v6.0.0 -> latest
synchronization - Enable/disable only advertise routes from iBGP if routes present in an IGP. type: str choices: enable, disable more...

Supported Version Ranges

synchronization v6.0.0 -> latest

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
tag_resolve_mode - Configure tag-match mode. Resolves BGP routes with other routes containing the same tag. type: str choices: disable, preferred, merge more...

Supported Version Ranges

tag_resolve_mode v7.0.4 -> latest

[disable] v6.0.0 -> latest
[preferred] v6.0.0 -> latest
[merge] v6.0.0 -> latest
vrf - BGP VRF leaking table. type: list member_path: vrf:vrf more...

Supported Version Ranges

vrf v7.2.0 -> latest

export_rt - List of export route target. type: list member_path: vrf:vrf/export_rt:route_target more...

Supported Version Ranges

export_rt v7.2.0 -> latest

route_target - Attribute: AA:NN|A.B.C.D:NN. type: str required: true more...

Supported Version Ranges

route_target v7.2.0 -> latest

import_route_map - Import route map. Source router.route-map.name. type: str more...

Supported Version Ranges

import_route_map v7.2.0 -> latest
import_rt - List of import route target. type: list member_path: vrf:vrf/import_rt:route_target more...

Supported Version Ranges

import_rt v7.2.0 -> latest

route_target - Attribute: AA:NN|A.B.C.D:NN type: str required: true more...

Supported Version Ranges

route_target v7.2.0 -> latest

leak_target - Target VRF table. type: list member_path: vrf:vrf/leak_target:vrf more...

Supported Version Ranges

leak_target v7.2.0 -> latest

interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...

Supported Version Ranges

interface v7.2.0 -> latest
route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v7.2.0 -> latest
vrf - Target VRF ID (0 - 251). type: str required: true more...

Supported Version Ranges

vrf v7.2.0 -> latest

rd - Route Distinguisher: AA:NN|A.B.C.D:NN. type: str more...

Supported Version Ranges

rd v7.2.0 -> latest
role - VRF role. type: str choices: standalone, ce, pe more...

Supported Version Ranges

role v7.2.0 -> latest

[standalone] v6.0.0 -> latest
[ce] v6.0.0 -> latest
[pe] v6.0.0 -> latest
vrf - Origin VRF ID (0 - 251). type: str required: true more...

Supported Version Ranges

vrf v7.2.0 -> latest

vrf_leak - BGP VRF leaking table. type: list member_path: vrf_leak:vrf more...

Supported Version Ranges

vrf_leak v6.4.0 -> v7.0.12

target - Target VRF table. type: list member_path: vrf_leak:vrf/target:vrf more...

Supported Version Ranges

target v6.4.0 -> v7.0.12

interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...

Supported Version Ranges

interface v6.4.0 -> v7.0.12
route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v6.4.0 -> v7.0.12
vrf - Target VRF ID (0 - 31). type: str required: true more...

Supported Version Ranges

vrf v6.4.0 -> v7.0.12

vrf - Origin VRF ID (0 - 31). type: str required: true more...

Supported Version Ranges

vrf v6.4.0 -> v7.0.12

vrf_leak6 - BGP IPv6 VRF leaking table. type: list member_path: vrf_leak6:vrf more...

Supported Version Ranges

vrf_leak6 v7.0.1 -> v7.0.12

target - Target VRF table. type: list member_path: vrf_leak6:vrf/target:vrf more...

Supported Version Ranges

target v7.0.1 -> v7.0.12

interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...

Supported Version Ranges

interface v7.0.1 -> v7.0.12
route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v7.0.1 -> v7.0.12
vrf - Target VRF ID (0 - 31). type: str required: true more...

Supported Version Ranges

vrf v7.0.1 -> v7.0.12

vrf - Origin VRF ID (0 - 31). type: str required: true more...

Supported Version Ranges

vrf v7.0.1 -> v7.0.12

vrf6 - BGP IPv6 VRF leaking table. type: list member_path: vrf6:vrf more...

Supported Version Ranges

vrf6 v7.2.0 -> latest

leak_target - Target VRF table. type: list member_path: vrf6:vrf/leak_target:vrf more...

Supported Version Ranges

leak_target v7.2.0 -> latest

interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...

Supported Version Ranges

interface v7.2.0 -> latest
route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...

Supported Version Ranges

route_map v7.2.0 -> latest
vrf - Target VRF ID (0 - 251). type: str required: true more...

Supported Version Ranges

vrf v7.2.0 -> latest

vrf - Origin VRF ID (0 - 251). type: str required: true more...

Supported Version Ranges

vrf v7.2.0 -> latest

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure BGP.
  fortinet.fortios.fortios_router_bgp:
      vdom: "{{ vdom }}"
      router_bgp:
          additional_path: "enable"
          additional_path_select: "2"
          additional_path_select_vpnv4: "2"
          additional_path_select6: "2"
          additional_path_vpnv4: "enable"
          additional_path6: "enable"
          admin_distance:
              -
                  distance: "0"
                  id: "11"
                  neighbour_prefix: "<your_own_value>"
                  route_list: "<your_own_value> (source router.access-list.name)"
          aggregate_address:
              -
                  as_set: "enable"
                  id: "16"
                  prefix: "<your_own_value>"
                  summary_only: "enable"
          aggregate_address6:
              -
                  as_set: "enable"
                  id: "21"
                  prefix6: "<your_own_value>"
                  summary_only: "enable"
          always_compare_med: "enable"
          as: "<your_own_value>"
          bestpath_as_path_ignore: "enable"
          bestpath_cmp_confed_aspath: "enable"
          bestpath_cmp_routerid: "enable"
          bestpath_med_confed: "enable"
          bestpath_med_missing_as_worst: "enable"
          client_to_client_reflection: "enable"
          cluster_id: "<your_own_value>"
          confederation_identifier: "0"
          confederation_peers:
              -
                  peer: "<your_own_value>"
          cross_family_conditional_adv: "enable"
          dampening: "enable"
          dampening_max_suppress_time: "60"
          dampening_reachability_half_life: "15"
          dampening_reuse: "750"
          dampening_route_map: "<your_own_value> (source router.route-map.name)"
          dampening_suppress: "2000"
          dampening_unreachability_half_life: "15"
          default_local_preference: "100"
          deterministic_med: "enable"
          distance_external: "20"
          distance_internal: "200"
          distance_local: "200"
          ebgp_multipath: "enable"
          enforce_first_as: "enable"
          fast_external_failover: "enable"
          graceful_end_on_timer: "enable"
          graceful_restart: "enable"
          graceful_restart_time: "120"
          graceful_stalepath_time: "360"
          graceful_update_delay: "120"
          holdtime_timer: "180"
          ibgp_multipath: "enable"
          ignore_optional_capability: "enable"
          keepalive_timer: "60"
          log_neighbour_changes: "enable"
          multipath_recursive_distance: "enable"
          neighbor:
              -
                  activate: "enable"
                  activate_evpn: "enable"
                  activate_vpnv4: "enable"
                  activate6: "enable"
                  additional_path: "send"
                  additional_path_vpnv4: "send"
                  additional_path6: "send"
                  adv_additional_path: "2"
                  adv_additional_path_vpnv4: "2"
                  adv_additional_path6: "2"
                  advertisement_interval: "30"
                  allowas_in: "3"
                  allowas_in_enable: "enable"
                  allowas_in_enable_evpn: "enable"
                  allowas_in_enable_vpnv4: "enable"
                  allowas_in_enable6: "enable"
                  allowas_in_evpn: "3"
                  allowas_in_vpnv4: "3"
                  allowas_in6: "3"
                  as_override: "enable"
                  as_override6: "enable"
                  attribute_unchanged: "as-path"
                  attribute_unchanged_vpnv4: "as-path"
                  attribute_unchanged6: "as-path"
                  bfd: "enable"
                  capability_default_originate: "enable"
                  capability_default_originate6: "enable"
                  capability_dynamic: "enable"
                  capability_graceful_restart: "enable"
                  capability_graceful_restart_evpn: "enable"
                  capability_graceful_restart_vpnv4: "enable"
                  capability_graceful_restart6: "enable"
                  capability_orf: "none"
                  capability_orf6: "none"
                  capability_route_refresh: "enable"
                  conditional_advertise:
                      -
                          advertise_routemap: "<your_own_value> (source router.route-map.name)"
                          condition_routemap:
                              -
                                  name: "default_name_102 (source router.route-map.name)"
                          condition_type: "exist"
                  conditional_advertise6:
                      -
                          advertise_routemap: "<your_own_value> (source router.route-map.name)"
                          condition_routemap:
                              -
                                  name: "default_name_107 (source router.route-map.name)"
                          condition_type: "exist"
                  connect_timer: "4294967295"
                  default_originate_routemap: "<your_own_value> (source router.route-map.name)"
                  default_originate_routemap6: "<your_own_value> (source router.route-map.name)"
                  description: "<your_own_value>"
                  distribute_list_in: "<your_own_value> (source router.access-list.name)"
                  distribute_list_in_vpnv4: "<your_own_value> (source router.access-list.name)"
                  distribute_list_in6: "<your_own_value> (source router.access-list6.name)"
                  distribute_list_out: "<your_own_value> (source router.access-list.name)"
                  distribute_list_out_vpnv4: "<your_own_value> (source router.access-list.name)"
                  distribute_list_out6: "<your_own_value> (source router.access-list6.name)"
                  dont_capability_negotiate: "enable"
                  ebgp_enforce_multihop: "enable"
                  ebgp_multihop_ttl: "255"
                  filter_list_in: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_in_vpnv4: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_in6: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_out: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_out_vpnv4: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_out6: "<your_own_value> (source router.aspath-list.name)"
                  holdtime_timer: "4294967295"
                  interface: "<your_own_value> (source system.interface.name)"
                  ip: "<your_own_value>"
                  keep_alive_timer: "4294967295"
                  link_down_failover: "enable"
                  local_as: "<your_own_value>"
                  local_as_no_prepend: "enable"
                  local_as_replace_as: "enable"
                  maximum_prefix: "0"
                  maximum_prefix_evpn: "0"
                  maximum_prefix_threshold: "75"
                  maximum_prefix_threshold_evpn: "75"
                  maximum_prefix_threshold_vpnv4: "75"
                  maximum_prefix_threshold6: "75"
                  maximum_prefix_vpnv4: "0"
                  maximum_prefix_warning_only: "enable"
                  maximum_prefix_warning_only_evpn: "enable"
                  maximum_prefix_warning_only_vpnv4: "enable"
                  maximum_prefix_warning_only6: "enable"
                  maximum_prefix6: "0"
                  next_hop_self: "enable"
                  next_hop_self_rr: "enable"
                  next_hop_self_rr6: "enable"
                  next_hop_self_vpnv4: "enable"
                  next_hop_self6: "enable"
                  override_capability: "enable"
                  passive: "enable"
                  password: "<your_own_value>"
                  prefix_list_in: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_in_vpnv4: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_in6: "<your_own_value> (source router.prefix-list6.name)"
                  prefix_list_out: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_out_vpnv4: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_out6: "<your_own_value> (source router.prefix-list6.name)"
                  remote_as: "<your_own_value>"
                  remove_private_as: "enable"
                  remove_private_as_evpn: "enable"
                  remove_private_as_vpnv4: "enable"
                  remove_private_as6: "enable"
                  restart_time: "0"
                  retain_stale_time: "0"
                  route_map_in: "<your_own_value> (source router.route-map.name)"
                  route_map_in_evpn: "<your_own_value> (source router.route-map.name)"
                  route_map_in_vpnv4: "<your_own_value> (source router.route-map.name)"
                  route_map_in6: "<your_own_value> (source router.route-map.name)"
                  route_map_out: "<your_own_value> (source router.route-map.name)"
                  route_map_out_evpn: "<your_own_value> (source router.route-map.name)"
                  route_map_out_preferable: "<your_own_value> (source router.route-map.name)"
                  route_map_out_vpnv4: "<your_own_value> (source router.route-map.name)"
                  route_map_out_vpnv4_preferable: "<your_own_value> (source router.route-map.name)"
                  route_map_out6: "<your_own_value> (source router.route-map.name)"
                  route_map_out6_preferable: "<your_own_value> (source router.route-map.name)"
                  route_reflector_client: "enable"
                  route_reflector_client_evpn: "enable"
                  route_reflector_client_vpnv4: "enable"
                  route_reflector_client6: "enable"
                  route_server_client: "enable"
                  route_server_client_evpn: "enable"
                  route_server_client_vpnv4: "enable"
                  route_server_client6: "enable"
                  send_community: "standard"
                  send_community_evpn: "standard"
                  send_community_vpnv4: "standard"
                  send_community6: "standard"
                  shutdown: "enable"
                  soft_reconfiguration: "enable"
                  soft_reconfiguration_evpn: "enable"
                  soft_reconfiguration_vpnv4: "enable"
                  soft_reconfiguration6: "enable"
                  stale_route: "enable"
                  strict_capability_match: "enable"
                  unsuppress_map: "<your_own_value> (source router.route-map.name)"
                  unsuppress_map6: "<your_own_value> (source router.route-map.name)"
                  update_source: "<your_own_value> (source system.interface.name)"
                  weight: "4294967295"
          neighbor_group:
              -
                  activate: "enable"
                  activate_evpn: "enable"
                  activate_vpnv4: "enable"
                  activate6: "enable"
                  additional_path: "send"
                  additional_path_vpnv4: "send"
                  additional_path6: "send"
                  adv_additional_path: "2"
                  adv_additional_path_vpnv4: "2"
                  adv_additional_path6: "2"
                  advertisement_interval: "30"
                  allowas_in: "3"
                  allowas_in_enable: "enable"
                  allowas_in_enable_evpn: "enable"
                  allowas_in_enable_vpnv4: "enable"
                  allowas_in_enable6: "enable"
                  allowas_in_evpn: "3"
                  allowas_in_vpnv4: "3"
                  allowas_in6: "3"
                  as_override: "enable"
                  as_override6: "enable"
                  attribute_unchanged: "as-path"
                  attribute_unchanged_vpnv4: "as-path"
                  attribute_unchanged6: "as-path"
                  bfd: "enable"
                  capability_default_originate: "enable"
                  capability_default_originate6: "enable"
                  capability_dynamic: "enable"
                  capability_graceful_restart: "enable"
                  capability_graceful_restart_evpn: "enable"
                  capability_graceful_restart_vpnv4: "enable"
                  capability_graceful_restart6: "enable"
                  capability_orf: "none"
                  capability_orf6: "none"
                  capability_route_refresh: "enable"
                  connect_timer: "4294967295"
                  default_originate_routemap: "<your_own_value> (source router.route-map.name)"
                  default_originate_routemap6: "<your_own_value> (source router.route-map.name)"
                  description: "<your_own_value>"
                  distribute_list_in: "<your_own_value> (source router.access-list.name)"
                  distribute_list_in_vpnv4: "<your_own_value> (source router.access-list.name)"
                  distribute_list_in6: "<your_own_value> (source router.access-list6.name)"
                  distribute_list_out: "<your_own_value> (source router.access-list.name)"
                  distribute_list_out_vpnv4: "<your_own_value> (source router.access-list.name)"
                  distribute_list_out6: "<your_own_value> (source router.access-list6.name)"
                  dont_capability_negotiate: "enable"
                  ebgp_enforce_multihop: "enable"
                  ebgp_multihop_ttl: "255"
                  filter_list_in: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_in_vpnv4: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_in6: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_out: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_out_vpnv4: "<your_own_value> (source router.aspath-list.name)"
                  filter_list_out6: "<your_own_value> (source router.aspath-list.name)"
                  holdtime_timer: "4294967295"
                  interface: "<your_own_value> (source system.interface.name)"
                  keep_alive_timer: "4294967295"
                  link_down_failover: "enable"
                  local_as: "<your_own_value>"
                  local_as_no_prepend: "enable"
                  local_as_replace_as: "enable"
                  maximum_prefix: "0"
                  maximum_prefix_evpn: "0"
                  maximum_prefix_threshold: "75"
                  maximum_prefix_threshold_evpn: "75"
                  maximum_prefix_threshold_vpnv4: "75"
                  maximum_prefix_threshold6: "75"
                  maximum_prefix_vpnv4: "0"
                  maximum_prefix_warning_only: "enable"
                  maximum_prefix_warning_only_evpn: "enable"
                  maximum_prefix_warning_only_vpnv4: "enable"
                  maximum_prefix_warning_only6: "enable"
                  maximum_prefix6: "0"
                  name: "default_name_277"
                  next_hop_self: "enable"
                  next_hop_self_rr: "enable"
                  next_hop_self_rr6: "enable"
                  next_hop_self_vpnv4: "enable"
                  next_hop_self6: "enable"
                  override_capability: "enable"
                  passive: "enable"
                  password: "<your_own_value>"
                  prefix_list_in: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_in_vpnv4: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_in6: "<your_own_value> (source router.prefix-list6.name)"
                  prefix_list_out: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_out_vpnv4: "<your_own_value> (source router.prefix-list.name)"
                  prefix_list_out6: "<your_own_value> (source router.prefix-list6.name)"
                  remote_as: "<your_own_value>"
                  remove_private_as: "enable"
                  remove_private_as_evpn: "enable"
                  remove_private_as_vpnv4: "enable"
                  remove_private_as6: "enable"
                  restart_time: "0"
                  retain_stale_time: "0"
                  route_map_in: "<your_own_value> (source router.route-map.name)"
                  route_map_in_evpn: "<your_own_value> (source router.route-map.name)"
                  route_map_in_vpnv4: "<your_own_value> (source router.route-map.name)"
                  route_map_in6: "<your_own_value> (source router.route-map.name)"
                  route_map_out: "<your_own_value> (source router.route-map.name)"
                  route_map_out_evpn: "<your_own_value> (source router.route-map.name)"
                  route_map_out_preferable: "<your_own_value> (source router.route-map.name)"
                  route_map_out_vpnv4: "<your_own_value> (source router.route-map.name)"
                  route_map_out_vpnv4_preferable: "<your_own_value> (source router.route-map.name)"
                  route_map_out6: "<your_own_value> (source router.route-map.name)"
                  route_map_out6_preferable: "<your_own_value> (source router.route-map.name)"
                  route_reflector_client: "enable"
                  route_reflector_client_evpn: "enable"
                  route_reflector_client_vpnv4: "enable"
                  route_reflector_client6: "enable"
                  route_server_client: "enable"
                  route_server_client_evpn: "enable"
                  route_server_client_vpnv4: "enable"
                  route_server_client6: "enable"
                  send_community: "standard"
                  send_community_evpn: "standard"
                  send_community_vpnv4: "standard"
                  send_community6: "standard"
                  shutdown: "enable"
                  soft_reconfiguration: "enable"
                  soft_reconfiguration_evpn: "enable"
                  soft_reconfiguration_vpnv4: "enable"
                  soft_reconfiguration6: "enable"
                  stale_route: "enable"
                  strict_capability_match: "enable"
                  unsuppress_map: "<your_own_value> (source router.route-map.name)"
                  unsuppress_map6: "<your_own_value> (source router.route-map.name)"
                  update_source: "<your_own_value> (source system.interface.name)"
                  weight: "4294967295"
          neighbor_range:
              -
                  id: "334"
                  max_neighbor_num: "0"
                  neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
                  prefix: "<your_own_value>"
          neighbor_range6:
              -
                  id: "339"
                  max_neighbor_num: "0"
                  neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
                  prefix6: "<your_own_value>"
          network:
              -
                  backdoor: "enable"
                  id: "345"
                  network_import_check: "global"
                  prefix: "<your_own_value>"
                  route_map: "<your_own_value> (source router.route-map.name)"
          network_import_check: "enable"
          network6:
              -
                  backdoor: "enable"
                  id: "352"
                  network_import_check: "global"
                  prefix6: "<your_own_value>"
                  route_map: "<your_own_value> (source router.route-map.name)"
          recursive_inherit_priority: "enable"
          recursive_next_hop: "enable"
          redistribute:
              -
                  name: "default_name_359"
                  route_map: "<your_own_value> (source router.route-map.name)"
                  status: "enable"
          redistribute6:
              -
                  name: "default_name_363"
                  route_map: "<your_own_value> (source router.route-map.name)"
                  status: "enable"
          router_id: "<your_own_value>"
          scan_time: "60"
          synchronization: "enable"
          tag_resolve_mode: "disable"
          vrf:
              -
                  export_rt:
                      -
                          route_target: "<your_own_value>"
                  import_route_map: "<your_own_value> (source router.route-map.name)"
                  import_rt:
                      -
                          route_target: "<your_own_value>"
                  leak_target:
                      -
                          interface: "<your_own_value> (source system.interface.name)"
                          route_map: "<your_own_value> (source router.route-map.name)"
                          vrf: "<your_own_value>"
                  rd: "<your_own_value>"
                  role: "standalone"
                  vrf: "<your_own_value>"
          vrf_leak:
              -
                  target:
                      -
                          interface: "<your_own_value> (source system.interface.name)"
                          route_map: "<your_own_value> (source router.route-map.name)"
                          vrf: "<your_own_value>"
                  vrf: "<your_own_value>"
          vrf_leak6:
              -
                  target:
                      -
                          interface: "<your_own_value> (source system.interface.name)"
                          route_map: "<your_own_value> (source router.route-map.name)"
                          vrf: "<your_own_value>"
                  vrf: "<your_own_value>"
          vrf6:
              -
                  leak_target:
                      -
                          interface: "<your_own_value> (source system.interface.name)"
                          route_map: "<your_own_value> (source router.route-map.name)"
                          vrf: "<your_own_value>"
                  vrf: "<your_own_value>"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

build - Build number of the fortigate image returned: always type: str sample: 1547
http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
revision - Internal revision number returned: always type: str sample: 17.0.2.10658
serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
status - Indication of the operation's result returned: always type: str sample: success
vdom - Virtual domain used returned: always type: str sample: root
version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

This module is not guaranteed to have a backwards compatible interface.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_router_bgp.rst

fortios_router_bgp.rst

fortios_router_bgp -- Configure BGP in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

	Supported Version Ranges
additional_path	`v6.2.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
additional_path_select	`v6.2.0 -> latest`

	Supported Version Ranges
additional_path_select_vpnv4	`v7.2.0 -> latest`

	Supported Version Ranges
additional_path_select6	`v6.2.0 -> latest`

	Supported Version Ranges
additional_path_vpnv4	`v7.2.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
additional_path6	`v6.2.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
as_set	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
summary_only	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
aggregate_address6	`v6.0.0 -> latest`

	Supported Version Ranges
always_compare_med	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
bestpath_as_path_ignore	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
bestpath_cmp_confed_aspath	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
bestpath_cmp_routerid	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
bestpath_med_confed	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
bestpath_med_missing_as_worst	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
client_to_client_reflection	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
confederation_identifier	`v6.0.0 -> latest`

	Supported Version Ranges
confederation_peers	`v6.0.0 -> latest`

	Supported Version Ranges
cross_family_conditional_adv	`v7.4.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
dampening	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

Files

fortios_router_bgp.rst

Latest commit

History

fortios_router_bgp.rst

File metadata and controls

fortios_router_bgp -- Configure BGP in Fortinet's FortiOS and FortiGate.

	Supported Version Ranges
dampening_max_suppress_time	`v6.0.0 -> latest`

	Supported Version Ranges
dampening_reachability_half_life	`v6.0.0 -> latest`

	Supported Version Ranges
dampening_route_map	`v6.0.0 -> latest`

	Supported Version Ranges
dampening_suppress	`v6.0.0 -> latest`

	Supported Version Ranges
dampening_unreachability_half_life	`v6.0.0 -> latest`

	Supported Version Ranges
default_local_preference	`v6.0.0 -> latest`

	Supported Version Ranges
deterministic_med	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
ebgp_multipath	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
enforce_first_as	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
fast_external_failover	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`