fortios_router_bgp – Configure BGP in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
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...
- additional_path - Enable/disable selection of BGP IPv4 additional paths. type: str choices: enable, disable more...
- additional_path_select - Number of additional paths to be selected for each IPv4 NLRI. type: int more...
- additional_path_select_vpnv4 - Number of additional paths to be selected for each VPNv4 NLRI. type: int more...
- additional_path_select_vpnv6 - Number of additional paths to be selected for each VPNv6 NLRI. type: int more...
- additional_path_select6 - Number of additional paths to be selected for each IPv6 NLRI. type: int more...
- additional_path_vpnv4 - Enable/disable selection of BGP VPNv4 additional paths. type: str choices: enable, disable more...
- additional_path_vpnv6 - Enable/disable selection of BGP VPNv6 additional paths. type: str choices: enable, disable more...
- additional_path6 - Enable/disable selection of BGP IPv6 additional paths. type: str choices: enable, disable more...
- admin_distance - Administrative distance modifications. type: list member_path: admin_distance:id more...
- distance - Administrative distance to apply (1 - 255). type: int more...
- id - ID. see Notes. type: int required: true more...
- neighbour_prefix - Neighbor address prefix. type: str more...
- route_list - Access list of routes to apply new distance to. Source router.access-list.name. type: str more...
- aggregate_address - BGP aggregate address table. type: list member_path: aggregate_address:id more...
- as_set - Enable/disable generate AS set path information. type: str choices: enable, disable more...
- id - ID. see Notes. type: int required: true more...
- prefix - Aggregate prefix. type: str more...
- summary_only - Enable/disable filter more specific routes from updates. type: str choices: enable, disable more...
- aggregate_address6 - BGP IPv6 aggregate address table. type: list member_path: aggregate_address6:id more...
- as_set - Enable/disable generate AS set path information. type: str choices: enable, disable more...
- id - ID. see Notes. type: int required: true more...
- prefix6 - Aggregate IPv6 prefix. type: str more...
- summary_only - Enable/disable filter more specific routes from updates. type: str choices: enable, disable more...
- always_compare_med - Enable/disable always compare MED. type: str choices: enable, disable more...
- as - Router AS number, asplain/asdot/asdot+ format, 0 to disable BGP. type: str more...
- bestpath_as_path_ignore - Enable/disable ignore AS path. type: str choices: enable, disable more...
- bestpath_cmp_confed_aspath - Enable/disable compare federation AS path length. type: str choices: enable, disable more...
- bestpath_cmp_routerid - Enable/disable compare router ID for identical EBGP paths. type: str choices: enable, disable more...
- bestpath_med_confed - Enable/disable compare MED among confederation paths. type: str choices: enable, disable more...
- bestpath_med_missing_as_worst - Enable/disable treat missing MED as least preferred. type: str choices: enable, disable more...
- client_to_client_reflection - Enable/disable client-to-client route reflection. type: str choices: enable, disable more...
- cluster_id - Route reflector cluster ID. type: str more...
- confederation_identifier - Confederation identifier. type: int more...
- confederation_peers - Confederation peers. type: list member_path: confederation_peers:peer more...
- peer - Peer ID. type: str required: true more...
- cross_family_conditional_adv - Enable/disable cross address family conditional advertisement. type: str choices: enable, disable more...
- dampening - Enable/disable route-flap dampening. type: str choices: enable, disable more...
- dampening_max_suppress_time - Maximum minutes a route can be suppressed. type: int more...
- dampening_reachability_half_life - Reachability half-life time for penalty (min). type: int more...
- dampening_reuse - Threshold to reuse routes. type: int more...
- dampening_route_map - Criteria for dampening. Source router.route-map.name. type: str more...
- dampening_suppress - Threshold to suppress routes. type: int more...
- dampening_unreachability_half_life - Unreachability half-life time for penalty (min). type: int more...
- default_local_preference - Default local preference. type: int more...
- deterministic_med - Enable/disable enforce deterministic comparison of MED. type: str choices: enable, disable more...
- distance_external - Distance for routes external to the AS. type: int more...
- distance_internal - Distance for routes internal to the AS. type: int more...
- distance_local - Distance for routes local to the AS. type: int more...
- ebgp_multipath - Enable/disable EBGP multi-path. type: str choices: enable, disable more...
- enforce_first_as - Enable/disable enforce first AS for EBGP routes. type: str choices: enable, disable more...
- fast_external_failover - Enable/disable reset peer BGP session if link goes down. type: str choices: enable, disable more...
- graceful_end_on_timer - Enable/disable to exit graceful restart on timer only. type: str choices: enable, disable more...
- graceful_restart - Enable/disable BGP graceful restart capabilities. type: str choices: enable, disable more...
- graceful_restart_time - Time needed for neighbors to restart (sec). type: int more...
- graceful_stalepath_time - Time to hold stale paths of restarting neighbor (sec). type: int more...
- graceful_update_delay - Route advertisement/selection delay after restart (sec). type: int more...
- holdtime_timer - Number of seconds to mark peer as dead. type: int more...
- ibgp_multipath - Enable/disable IBGP multi-path. type: str choices: enable, disable more...
- ignore_optional_capability - Do not send unknown optional capability notification message. type: str choices: enable, disable more...
- keepalive_timer - Frequency to send keep alive requests. type: int more...
- log_neighbour_changes - Log BGP neighbor changes. type: str choices: enable, disable more...
- multipath_recursive_distance - Enable/disable use of recursive distance to select multipath. type: str choices: enable, disable more...
- neighbor - BGP neighbor table. type: list member_path: neighbor:ip more...
- activate - Enable/disable address family IPv4 for this neighbor. type: str choices: enable, disable more...
- activate_evpn - Enable/disable address family L2VPN EVPN for this neighbor. type: str choices: enable, disable more...
- activate_vpnv4 - Enable/disable address family VPNv4 for this neighbor. type: str choices: enable, disable more...
- activate_vpnv6 - Enable/disable address family VPNv6 for this neighbor. type: str choices: enable, disable more...
- activate6 - Enable/disable address family IPv6 for this neighbor. type: str choices: enable, disable more...
- additional_path - Enable/disable IPv4 additional-path capability. type: str choices: send, receive, both, disable more...
- additional_path_vpnv4 - Enable/disable VPNv4 additional-path capability. type: str choices: send, receive, both, disable more...
- additional_path_vpnv6 - Enable/disable VPNv6 additional-path capability. type: str choices: send, receive, both, disable more...
- additional_path6 - Enable/disable IPv6 additional-path capability. type: str choices: send, receive, both, disable more...
- adv_additional_path - Number of IPv4 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path_vpnv4 - Number of VPNv4 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path_vpnv6 - Number of VPNv6 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path6 - Number of IPv6 additional paths that can be advertised to this neighbor. type: int more...
- advertisement_interval - Minimum interval (sec) between sending updates. type: int more...
- allowas_in - IPv4 The maximum number of occurrence of my AS number allowed. type: int more...
- allowas_in_enable - Enable/disable IPv4 Enable to allow my AS in AS path. type: str choices: enable, disable more...
- allowas_in_enable_evpn - Enable/disable to allow my AS in AS path for L2VPN EVPN route. type: str choices: enable, disable more...
- allowas_in_enable_vpnv4 - Enable/disable to allow my AS in AS path for VPNv4 route. type: str choices: enable, disable more...
- allowas_in_enable_vpnv6 - Enable/disable use of my AS in AS path for VPNv6 route. type: str choices: enable, disable more...
- allowas_in_enable6 - Enable/disable IPv6 Enable to allow my AS in AS path. type: str choices: enable, disable more...
- allowas_in_evpn - The maximum number of occurrence of my AS number allowed for L2VPN EVPN route. type: int more...
- allowas_in_vpnv4 - The maximum number of occurrence of my AS number allowed for VPNv4 route. type: int more...
- allowas_in_vpnv6 - The maximum number of occurrence of my AS number allowed for VPNv6 route. type: int more...
- allowas_in6 - IPv6 The maximum number of occurrence of my AS number allowed. type: int more...
- as_override - Enable/disable replace peer AS with own AS for IPv4. type: str choices: enable, disable more...
- as_override6 - Enable/disable replace peer AS with own AS for IPv6. type: str choices: enable, disable more...
- attribute_unchanged - IPv4 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...
- attribute_unchanged_vpnv4 - List of attributes that should be unchanged for VPNv4 route. type: list choices: as-path, med, next-hop more...
- attribute_unchanged_vpnv6 - List of attributes that should not be changed for VPNv6 route. type: list choices: as-path, med, next-hop more...
- attribute_unchanged6 - IPv6 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...
- auth_options - Key-chain name for TCP authentication options. Source router.key-chain.name. type: str more...
- bfd - Enable/disable BFD for this neighbor. type: str choices: enable, disable more...
- capability_default_originate - Enable/disable advertise default IPv4 route to this neighbor. type: str choices: enable, disable more...
- capability_default_originate6 - Enable/disable advertise default IPv6 route to this neighbor. type: str choices: enable, disable more...
- capability_dynamic - Enable/disable advertise dynamic capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart - Enable/disable advertise IPv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart_evpn - Enable/disable advertisement of L2VPN EVPN graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart_vpnv4 - Enable/disable advertise VPNv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart_vpnv6 - Enable/disable advertisement of VPNv6 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart6 - Enable/disable advertise IPv6 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_orf - Accept/Send IPv4 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...
- capability_orf6 - Accept/Send IPv6 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...
- capability_route_refresh - Enable/disable advertise route refresh capability to this neighbor. type: str choices: enable, disable more...
- conditional_advertise - Conditional advertisement. type: list member_path: neighbor:ip/conditional_advertise:advertise_routemap more...
- advertise_routemap - Name of advertising route map. Source router.route-map.name. type: str required: true more...
- 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...
- name - Route map. Source router.route-map.name. type: str required: true more...
- condition_type - Type of condition. type: str choices: exist, non-exist more...
- conditional_advertise6 - IPv6 conditional advertisement. type: list member_path: neighbor:ip/conditional_advertise6:advertise_routemap more...
- advertise_routemap - Name of advertising route map. Source router.route-map.name. type: str required: true more...
- 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...
- name - Route map. Source router.route-map.name. type: str required: true more...
- condition_type - Type of condition. type: str choices: exist, non-exist more...
- connect_timer - Interval (sec) for connect timer. type: int more...
- default_originate_routemap - Route map to specify criteria to originate IPv4 default. Source router.route-map.name. type: str more...
- default_originate_routemap6 - Route map to specify criteria to originate IPv6 default. Source router.route-map.name. type: str more...
- description - Description. type: str more...
- distribute_list_in - Filter for IPv4 updates from this neighbor. Source router.access-list.name. type: str more...
- distribute_list_in_vpnv4 - Filter for VPNv4 updates from this neighbor. Source router.access-list.name. type: str more...
- distribute_list_in_vpnv6 - Filter for VPNv6 updates from this neighbor. Source router.access-list6.name. type: str more...
- distribute_list_in6 - Filter for IPv6 updates from this neighbor. Source router.access-list6.name. type: str more...
- distribute_list_out - Filter for IPv4 updates to this neighbor. Source router.access-list.name. type: str more...
- distribute_list_out_vpnv4 - Filter for VPNv4 updates to this neighbor. Source router.access-list.name. type: str more...
- distribute_list_out_vpnv6 - Filter for VPNv6 updates to this neighbor. Source router.access-list6.name. type: str more...
- distribute_list_out6 - Filter for IPv6 updates to this neighbor. Source router.access-list6.name. type: str more...
- dont_capability_negotiate - Do not negotiate capabilities with this neighbor. type: str choices: enable, disable more...
- ebgp_enforce_multihop - Enable/disable allow multi-hop EBGP neighbors. type: str choices: enable, disable more...
- ebgp_multihop_ttl - EBGP multihop TTL for this peer. type: int more...
- filter_list_in - BGP filter for IPv4 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_in_vpnv4 - BGP filter for VPNv4 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_in_vpnv6 - BGP filter for VPNv6 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_in6 - BGP filter for IPv6 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out - BGP filter for IPv4 outbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out_vpnv4 - BGP filter for VPNv4 outbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out_vpnv6 - BGP filter for VPNv6 outbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out6 - BGP filter for IPv6 outbound routes. Source router.aspath-list.name. type: str more...
- holdtime_timer - Interval (sec) before peer considered dead. type: int more...
- interface - Specify outgoing interface for peer connection. For IPv6 peer, the interface should have link-local address. Source system .interface.name. type: str more...
- ip - IP/IPv6 address of neighbor. type: str required: true more...
- keep_alive_timer - Keep alive timer interval (sec). type: int more...
- link_down_failover - Enable/disable failover upon link down. type: str choices: enable, disable more...
- local_as - Local AS number of neighbor. type: str more...
- local_as_no_prepend - Do not prepend local-as to incoming updates. type: str choices: enable, disable more...
- local_as_replace_as - Replace real AS with local-as in outgoing updates. type: str choices: enable, disable more...
- maximum_prefix - Maximum number of IPv4 prefixes to accept from this peer. type: int more...
- maximum_prefix_evpn - Maximum number of L2VPN EVPN prefixes to accept from this peer. type: int more...
- maximum_prefix_threshold - Maximum IPv4 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_evpn - Maximum L2VPN EVPN prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_vpnv4 - Maximum VPNv4 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_vpnv6 - Maximum VPNv6 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold6 - Maximum IPv6 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_vpnv4 - Maximum number of VPNv4 prefixes to accept from this peer. type: int more...
- maximum_prefix_vpnv6 - Maximum number of VPNv6 prefixes to accept from this peer. type: int more...
- maximum_prefix_warning_only - Enable/disable IPv4 Only give warning message when limit is exceeded. type: str choices: enable, disable more...
- maximum_prefix_warning_only_evpn - Enable/disable only sending warning message when exceeding limit of L2VPN EVPN routes. type: str choices: enable, disable more...
- maximum_prefix_warning_only_vpnv4 - Enable/disable only giving warning message when limit is exceeded for VPNv4 routes. type: str choices: enable, disable more...
- maximum_prefix_warning_only_vpnv6 - Enable/disable warning message when limit is exceeded for VPNv6 routes. type: str choices: enable, disable more...
- maximum_prefix_warning_only6 - Enable/disable IPv6 Only give warning message when limit is exceeded. type: str choices: enable, disable more...
- maximum_prefix6 - Maximum number of IPv6 prefixes to accept from this peer. type: int more...
- next_hop_self - Enable/disable IPv4 next-hop calculation for this neighbor. type: str choices: enable, disable more...
- 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...
- 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...
- next_hop_self_vpnv4 - Enable/disable setting VPNv4 next-hop to interface"s IP address for this neighbor. type: str choices: enable, disable more...
- next_hop_self_vpnv6 - Enable/disable use of outgoing interface"s IP address as VPNv6 next-hop for this neighbor. type: str choices: enable, disable more...
- next_hop_self6 - Enable/disable IPv6 next-hop calculation for this neighbor. type: str choices: enable, disable more...
- override_capability - Enable/disable override result of capability negotiation. type: str choices: enable, disable more...
- passive - Enable/disable sending of open messages to this neighbor. type: str choices: enable, disable more...
- password - Password used in MD5 authentication. type: str more...
- prefix_list_in - IPv4 Inbound filter for updates from this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_in_vpnv4 - Inbound filter for VPNv4 updates from this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_in_vpnv6 - Inbound filter for VPNv6 updates from this neighbor. Source router.prefix-list6.name. type: str more...
- prefix_list_in6 - IPv6 Inbound filter for updates from this neighbor. Source router.prefix-list6.name. type: str more...
- prefix_list_out - IPv4 Outbound filter for updates to this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_out_vpnv4 - Outbound filter for VPNv4 updates to this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_out_vpnv6 - Outbound filter for VPNv6 updates to this neighbor. Source router.prefix-list6.name. type: str more...
- prefix_list_out6 - IPv6 Outbound filter for updates to this neighbor. Source router.prefix-list6.name. type: str more...
- remote_as - AS number of neighbor. type: str more...
- remove_private_as - Enable/disable remove private AS number from IPv4 outbound updates. type: str choices: enable, disable more...
- remove_private_as_evpn - Enable/disable removing private AS number from L2VPN EVPN outbound updates. type: str choices: enable, disable more...
- remove_private_as_vpnv4 - Enable/disable remove private AS number from VPNv4 outbound updates. type: str choices: enable, disable more...
- remove_private_as_vpnv6 - Enable/disable to remove private AS number from VPNv6 outbound updates. type: str choices: enable, disable more...
- remove_private_as6 - Enable/disable remove private AS number from IPv6 outbound updates. type: str choices: enable, disable more...
- restart_time - Graceful restart delay time (sec, 0 = global default). type: int more...
- retain_stale_time - Time to retain stale routes. type: int more...
- route_map_in - IPv4 Inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in_evpn - L2VPN EVPN inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in_vpnv4 - VPNv4 inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in_vpnv6 - VPNv6 inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in6 - IPv6 Inbound route map filter. Source router.route-map.name. type: str more...
- route_map_out - IPv4 outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_evpn - L2VPN EVPN outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_preferable - IPv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...
- route_map_out_vpnv4 - VPNv4 outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_vpnv4_preferable - VPNv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...
- route_map_out_vpnv6 - VPNv6 outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_vpnv6_preferable - VPNv6 outbound route map filter if this neighbor is preferred. Source router.route-map.name. type: str more...
- route_map_out6 - IPv6 Outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out6_preferable - IPv6 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...
- route_reflector_client - Enable/disable IPv4 AS route reflector client. type: str choices: enable, disable more...
- route_reflector_client_evpn - Enable/disable L2VPN EVPN AS route reflector client for this neighbor. type: str choices: enable, disable more...
- route_reflector_client_vpnv4 - Enable/disable VPNv4 AS route reflector client for this neighbor. type: str choices: enable, disable more...
- route_reflector_client_vpnv6 - Enable/disable VPNv6 AS route reflector client for this neighbor. type: str choices: enable, disable more...
- route_reflector_client6 - Enable/disable IPv6 AS route reflector client. type: str choices: enable, disable more...
- route_server_client - Enable/disable IPv4 AS route server client. type: str choices: enable, disable more...
- route_server_client_evpn - Enable/disable L2VPN EVPN AS route server client for this neighbor. type: str choices: enable, disable more...
- route_server_client_vpnv4 - Enable/disable VPNv4 AS route server client for this neighbor. type: str choices: enable, disable more...
- route_server_client_vpnv6 - Enable/disable VPNv6 AS route server client for this neighbor. type: str choices: enable, disable more...
- route_server_client6 - Enable/disable IPv6 AS route server client. type: str choices: enable, disable more...
- send_community - IPv4 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...
- send_community_evpn - Enable/disable sending community attribute to neighbor for L2VPN EVPN address family. type: str choices: standard, extended, both, disable more...
- send_community_vpnv4 - Send community attribute to neighbor for VPNv4 address family. type: str choices: standard, extended, both, disable more...
- send_community_vpnv6 - Enable/disable sending community attribute to this neighbor for VPNv6 address family. type: str choices: standard, extended, both, disable more...
- send_community6 - IPv6 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...
- shutdown - Enable/disable shutdown this neighbor. type: str choices: enable, disable more...
- soft_reconfiguration - Enable/disable allow IPv4 inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration_evpn - Enable/disable L2VPN EVPN inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration_vpnv4 - Enable/disable allow VPNv4 inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration_vpnv6 - Enable/disable VPNv6 inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration6 - Enable/disable allow IPv6 inbound soft reconfiguration. type: str choices: enable, disable more...
- stale_route - Enable/disable stale route after neighbor down. type: str choices: enable, disable more...
- strict_capability_match - Enable/disable strict capability matching. type: str choices: enable, disable more...
- unsuppress_map - IPv4 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...
- unsuppress_map6 - IPv6 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...
- update_source - Interface to use as source IP/IPv6 address of TCP connections. Source system.interface.name. type: str more...
- weight - Neighbor weight. type: int more...
- neighbor_group - BGP neighbor group table. type: list member_path: neighbor_group:name more...
- activate - Enable/disable address family IPv4 for this neighbor. type: str choices: enable, disable more...
- activate_evpn - Enable/disable address family L2VPN EVPN for this neighbor. type: str choices: enable, disable more...
- activate_vpnv4 - Enable/disable address family VPNv4 for this neighbor. type: str choices: enable, disable more...
- activate_vpnv6 - Enable/disable address family VPNv6 for this neighbor. type: str choices: enable, disable more...
- activate6 - Enable/disable address family IPv6 for this neighbor. type: str choices: enable, disable more...
- additional_path - Enable/disable IPv4 additional-path capability. type: str choices: send, receive, both, disable more...
- additional_path_vpnv4 - Enable/disable VPNv4 additional-path capability. type: str choices: send, receive, both, disable more...
- additional_path_vpnv6 - Enable/disable VPNv6 additional-path capability. type: str choices: send, receive, both, disable more...
- additional_path6 - Enable/disable IPv6 additional-path capability. type: str choices: send, receive, both, disable more...
- adv_additional_path - Number of IPv4 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path_vpnv4 - Number of VPNv4 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path_vpnv6 - Number of VPNv6 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path6 - Number of IPv6 additional paths that can be advertised to this neighbor. type: int more...
- advertisement_interval - Minimum interval (sec) between sending updates. type: int more...
- allowas_in - IPv4 The maximum number of occurrence of my AS number allowed. type: int more...
- allowas_in_enable - Enable/disable IPv4 Enable to allow my AS in AS path. type: str choices: enable, disable more...
- allowas_in_enable_evpn - Enable/disable to allow my AS in AS path for L2VPN EVPN route. type: str choices: enable, disable more...
- allowas_in_enable_vpnv4 - Enable/disable to allow my AS in AS path for VPNv4 route. type: str choices: enable, disable more...
- allowas_in_enable_vpnv6 - Enable/disable use of my AS in AS path for VPNv6 route. type: str choices: enable, disable more...
- allowas_in_enable6 - Enable/disable IPv6 Enable to allow my AS in AS path. type: str choices: enable, disable more...
- allowas_in_evpn - The maximum number of occurrence of my AS number allowed for L2VPN EVPN route. type: int more...
- allowas_in_vpnv4 - The maximum number of occurrence of my AS number allowed for VPNv4 route. type: int more...
- allowas_in_vpnv6 - The maximum number of occurrence of my AS number allowed for VPNv6 route. type: int more...
- allowas_in6 - IPv6 The maximum number of occurrence of my AS number allowed. type: int more...
- as_override - Enable/disable replace peer AS with own AS for IPv4. type: str choices: enable, disable more...
- as_override6 - Enable/disable replace peer AS with own AS for IPv6. type: str choices: enable, disable more...
- attribute_unchanged - IPv4 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...
- attribute_unchanged_vpnv4 - List of attributes that should be unchanged for VPNv4 route. type: list choices: as-path, med, next-hop more...
- attribute_unchanged_vpnv6 - List of attributes that should not be changed for VPNv6 route. type: list choices: as-path, med, next-hop more...
- attribute_unchanged6 - IPv6 List of attributes that should be unchanged. type: list choices: as-path, med, next-hop more...
- auth_options - Key-chain name for TCP authentication options. Source router.key-chain.name. type: str more...
- bfd - Enable/disable BFD for this neighbor. type: str choices: enable, disable more...
- capability_default_originate - Enable/disable advertise default IPv4 route to this neighbor. type: str choices: enable, disable more...
- capability_default_originate6 - Enable/disable advertise default IPv6 route to this neighbor. type: str choices: enable, disable more...
- capability_dynamic - Enable/disable advertise dynamic capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart - Enable/disable advertise IPv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart_evpn - Enable/disable advertisement of L2VPN EVPN graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart_vpnv4 - Enable/disable advertise VPNv4 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart_vpnv6 - Enable/disable advertisement of VPNv6 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_graceful_restart6 - Enable/disable advertise IPv6 graceful restart capability to this neighbor. type: str choices: enable, disable more...
- capability_orf - Accept/Send IPv4 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...
- capability_orf6 - Accept/Send IPv6 ORF lists to/from this neighbor. type: str choices: none, receive, send, both more...
- capability_route_refresh - Enable/disable advertise route refresh capability to this neighbor. type: str choices: enable, disable more...
- connect_timer - Interval (sec) for connect timer. type: int more...
- default_originate_routemap - Route map to specify criteria to originate IPv4 default. Source router.route-map.name. type: str more...
- default_originate_routemap6 - Route map to specify criteria to originate IPv6 default. Source router.route-map.name. type: str more...
- description - Description. type: str more...
- distribute_list_in - Filter for IPv4 updates from this neighbor. Source router.access-list.name. type: str more...
- distribute_list_in_vpnv4 - Filter for VPNv4 updates from this neighbor. Source router.access-list.name. type: str more...
- distribute_list_in_vpnv6 - Filter for VPNv6 updates from this neighbor. Source router.access-list6.name. type: str more...
- distribute_list_in6 - Filter for IPv6 updates from this neighbor. Source router.access-list6.name. type: str more...
- distribute_list_out - Filter for IPv4 updates to this neighbor. Source router.access-list.name. type: str more...
- distribute_list_out_vpnv4 - Filter for VPNv4 updates to this neighbor. Source router.access-list.name. type: str more...
- distribute_list_out_vpnv6 - Filter for VPNv6 updates to this neighbor. Source router.access-list6.name. type: str more...
- distribute_list_out6 - Filter for IPv6 updates to this neighbor. Source router.access-list6.name. type: str more...
- dont_capability_negotiate - Do not negotiate capabilities with this neighbor. type: str choices: enable, disable more...
- ebgp_enforce_multihop - Enable/disable allow multi-hop EBGP neighbors. type: str choices: enable, disable more...
- ebgp_multihop_ttl - EBGP multihop TTL for this peer. type: int more...
- filter_list_in - BGP filter for IPv4 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_in_vpnv4 - BGP filter for VPNv4 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_in_vpnv6 - BGP filter for VPNv6 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_in6 - BGP filter for IPv6 inbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out - BGP filter for IPv4 outbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out_vpnv4 - BGP filter for VPNv4 outbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out_vpnv6 - BGP filter for VPNv6 outbound routes. Source router.aspath-list.name. type: str more...
- filter_list_out6 - BGP filter for IPv6 outbound routes. Source router.aspath-list.name. type: str more...
- holdtime_timer - Interval (sec) before peer considered dead. type: int more...
- interface - Specify outgoing interface for peer connection. For IPv6 peer, the interface should have link-local address. Source system .interface.name. type: str more...
- keep_alive_timer - Keep alive timer interval (sec). type: int more...
- link_down_failover - Enable/disable failover upon link down. type: str choices: enable, disable more...
- local_as - Local AS number of neighbor. type: str more...
- local_as_no_prepend - Do not prepend local-as to incoming updates. type: str choices: enable, disable more...
- local_as_replace_as - Replace real AS with local-as in outgoing updates. type: str choices: enable, disable more...
- maximum_prefix - Maximum number of IPv4 prefixes to accept from this peer. type: int more...
- maximum_prefix_evpn - Maximum number of L2VPN EVPN prefixes to accept from this peer. type: int more...
- maximum_prefix_threshold - Maximum IPv4 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_evpn - Maximum L2VPN EVPN prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_vpnv4 - Maximum VPNv4 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_vpnv6 - Maximum VPNv6 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold6 - Maximum IPv6 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_vpnv4 - Maximum number of VPNv4 prefixes to accept from this peer. type: int more...
- maximum_prefix_vpnv6 - Maximum number of VPNv6 prefixes to accept from this peer. type: int more...
- maximum_prefix_warning_only - Enable/disable IPv4 Only give warning message when limit is exceeded. type: str choices: enable, disable more...
- maximum_prefix_warning_only_evpn - Enable/disable only sending warning message when exceeding limit of L2VPN EVPN routes. type: str choices: enable, disable more...
- maximum_prefix_warning_only_vpnv4 - Enable/disable only giving warning message when limit is exceeded for VPNv4 routes. type: str choices: enable, disable more...
- maximum_prefix_warning_only_vpnv6 - Enable/disable warning message when limit is exceeded for VPNv6 routes. type: str choices: enable, disable more...
- maximum_prefix_warning_only6 - Enable/disable IPv6 Only give warning message when limit is exceeded. type: str choices: enable, disable more...
- maximum_prefix6 - Maximum number of IPv6 prefixes to accept from this peer. type: int more...
- name - Neighbor group name. type: str required: true more...
- next_hop_self - Enable/disable IPv4 next-hop calculation for this neighbor. type: str choices: enable, disable more...
- 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...
- 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...
- next_hop_self_vpnv4 - Enable/disable setting VPNv4 next-hop to interface"s IP address for this neighbor. type: str choices: enable, disable more...
- next_hop_self_vpnv6 - Enable/disable use of outgoing interface"s IP address as VPNv6 next-hop for this neighbor. type: str choices: enable, disable more...
- next_hop_self6 - Enable/disable IPv6 next-hop calculation for this neighbor. type: str choices: enable, disable more...
- override_capability - Enable/disable override result of capability negotiation. type: str choices: enable, disable more...
- passive - Enable/disable sending of open messages to this neighbor. type: str choices: enable, disable more...
- password - Password used in MD5 authentication. type: str more...
- prefix_list_in - IPv4 Inbound filter for updates from this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_in_vpnv4 - Inbound filter for VPNv4 updates from this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_in_vpnv6 - Inbound filter for VPNv6 updates from this neighbor. Source router.prefix-list6.name. type: str more...
- prefix_list_in6 - IPv6 Inbound filter for updates from this neighbor. Source router.prefix-list6.name. type: str more...
- prefix_list_out - IPv4 Outbound filter for updates to this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_out_vpnv4 - Outbound filter for VPNv4 updates to this neighbor. Source router.prefix-list.name. type: str more...
- prefix_list_out_vpnv6 - Outbound filter for VPNv6 updates to this neighbor. Source router.prefix-list6.name. type: str more...
- prefix_list_out6 - IPv6 Outbound filter for updates to this neighbor. Source router.prefix-list6.name. type: str more...
- remote_as - AS number of neighbor. type: str more...
- remove_private_as - Enable/disable remove private AS number from IPv4 outbound updates. type: str choices: enable, disable more...
- remove_private_as_evpn - Enable/disable removing private AS number from L2VPN EVPN outbound updates. type: str choices: enable, disable more...
- remove_private_as_vpnv4 - Enable/disable remove private AS number from VPNv4 outbound updates. type: str choices: enable, disable more...
- remove_private_as_vpnv6 - Enable/disable to remove private AS number from VPNv6 outbound updates. type: str choices: enable, disable more...
- remove_private_as6 - Enable/disable remove private AS number from IPv6 outbound updates. type: str choices: enable, disable more...
- restart_time - Graceful restart delay time (sec, 0 = global default). type: int more...
- retain_stale_time - Time to retain stale routes. type: int more...
- route_map_in - IPv4 Inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in_evpn - L2VPN EVPN inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in_vpnv4 - VPNv4 inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in_vpnv6 - VPNv6 inbound route map filter. Source router.route-map.name. type: str more...
- route_map_in6 - IPv6 Inbound route map filter. Source router.route-map.name. type: str more...
- route_map_out - IPv4 outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_evpn - L2VPN EVPN outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_preferable - IPv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...
- route_map_out_vpnv4 - VPNv4 outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_vpnv4_preferable - VPNv4 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...
- route_map_out_vpnv6 - VPNv6 outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out_vpnv6_preferable - VPNv6 outbound route map filter if this neighbor is preferred. Source router.route-map.name. type: str more...
- route_map_out6 - IPv6 Outbound route map filter. Source router.route-map.name. type: str more...
- route_map_out6_preferable - IPv6 outbound route map filter if the peer is preferred. Source router.route-map.name. type: str more...
- route_reflector_client - Enable/disable IPv4 AS route reflector client. type: str choices: enable, disable more...
- route_reflector_client_evpn - Enable/disable L2VPN EVPN AS route reflector client for this neighbor. type: str choices: enable, disable more...
- route_reflector_client_vpnv4 - Enable/disable VPNv4 AS route reflector client for this neighbor. type: str choices: enable, disable more...
- route_reflector_client_vpnv6 - Enable/disable VPNv6 AS route reflector client for this neighbor. type: str choices: enable, disable more...
- route_reflector_client6 - Enable/disable IPv6 AS route reflector client. type: str choices: enable, disable more...
- route_server_client - Enable/disable IPv4 AS route server client. type: str choices: enable, disable more...
- route_server_client_evpn - Enable/disable L2VPN EVPN AS route server client for this neighbor. type: str choices: enable, disable more...
- route_server_client_vpnv4 - Enable/disable VPNv4 AS route server client for this neighbor. type: str choices: enable, disable more...
- route_server_client_vpnv6 - Enable/disable VPNv6 AS route server client for this neighbor. type: str choices: enable, disable more...
- route_server_client6 - Enable/disable IPv6 AS route server client. type: str choices: enable, disable more...
- send_community - IPv4 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...
- send_community_evpn - Enable/disable sending community attribute to neighbor for L2VPN EVPN address family. type: str choices: standard, extended, both, disable more...
- send_community_vpnv4 - Send community attribute to neighbor for VPNv4 address family. type: str choices: standard, extended, both, disable more...
- send_community_vpnv6 - Enable/disable sending community attribute to this neighbor for VPNv6 address family. type: str choices: standard, extended, both, disable more...
- send_community6 - IPv6 Send community attribute to neighbor. type: str choices: standard, extended, both, disable more...
- shutdown - Enable/disable shutdown this neighbor. type: str choices: enable, disable more...
- soft_reconfiguration - Enable/disable allow IPv4 inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration_evpn - Enable/disable L2VPN EVPN inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration_vpnv4 - Enable/disable allow VPNv4 inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration_vpnv6 - Enable/disable VPNv6 inbound soft reconfiguration. type: str choices: enable, disable more...
- soft_reconfiguration6 - Enable/disable allow IPv6 inbound soft reconfiguration. type: str choices: enable, disable more...
- stale_route - Enable/disable stale route after neighbor down. type: str choices: enable, disable more...
- strict_capability_match - Enable/disable strict capability matching. type: str choices: enable, disable more...
- unsuppress_map - IPv4 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...
- unsuppress_map6 - IPv6 Route map to selectively unsuppress suppressed routes. Source router.route-map.name. type: str more...
- update_source - Interface to use as source IP/IPv6 address of TCP connections. Source system.interface.name. type: str more...
- weight - Neighbor weight. type: int more...
- neighbor_range - BGP neighbor range table. type: list member_path: neighbor_range:id more...
- id - Neighbor range ID. see Notes. type: int required: true more...
- max_neighbor_num - Maximum number of neighbors. type: int more...
- neighbor_group - Neighbor group name. Source router.bgp.neighbor-group.name. type: str more...
- prefix - Neighbor range prefix. type: str more...
- neighbor_range6 - BGP IPv6 neighbor range table. type: list member_path: neighbor_range6:id more...
- id - IPv6 neighbor range ID. see Notes. type: int required: true more...
- max_neighbor_num - Maximum number of neighbors. type: int more...
- neighbor_group - Neighbor group name. Source router.bgp.neighbor-group.name. type: str more...
- prefix6 - IPv6 prefix. type: str more...
- network - BGP network table. type: list member_path: network:id more...
- backdoor - Enable/disable route as backdoor. type: str choices: enable, disable more...
- id - ID. see Notes. type: int required: true more...
- network_import_check - Configure insurance of BGP network route existence in IGP. type: str choices: global, enable, disable more...
- prefix - Network prefix. type: str more...
- route_map - Route map to modify generated route. Source router.route-map.name. type: str more...
- network_import_check - Enable/disable ensure BGP network route exists in IGP. type: str choices: enable, disable more...
- network6 - BGP IPv6 network table. type: list member_path: network6:id more...
- backdoor - Enable/disable route as backdoor. type: str choices: enable, disable more...
- id - ID. see Notes. type: int required: true more...
- network_import_check - Configure insurance of BGP network route existence in IGP. type: str choices: global, enable, disable more...
- prefix6 - Network IPv6 prefix. type: str more...
- route_map - Route map to modify generated route. Source router.route-map.name. type: str more...
- recursive_inherit_priority - Enable/disable priority inheritance for recursive resolution. type: str choices: enable, disable more...
- recursive_next_hop - Enable/disable recursive resolution of next-hop using BGP route. type: str choices: enable, disable more...
- redistribute - BGP IPv4 redistribute table. type: list member_path: redistribute:name more...
- name - Distribute list entry name. type: str required: true more...
- route_map - Route map name. Source router.route-map.name. type: str more...
- status - Status. type: str choices: enable, disable more...
- redistribute6 - BGP IPv6 redistribute table. type: list member_path: redistribute6:name more...
- name - Distribute list entry name. type: str required: true more...
- route_map - Route map name. Source router.route-map.name. type: str more...
- status - Status. type: str choices: enable, disable more...
- router_id - Router ID. type: str more...
- scan_time - Background scanner interval (sec), 0 to disable it. type: int more...
- synchronization - Enable/disable only advertise routes from iBGP if routes present in an IGP. type: str choices: enable, disable more...
- tag_resolve_mode - Configure tag-match mode. Resolves BGP routes with other routes containing the same tag. type: str choices: disable, preferred, merge more...
- vrf - BGP VRF leaking table. type: list member_path: vrf:vrf more...
- export_rt - List of export route target. type: list member_path: vrf:vrf/export_rt:route_target more...
- route_target - Attribute: AA:NN|A.B.C.D:NN. type: str required: true more...
- import_route_map - Import route map. Source router.route-map.name. type: str more...
- import_rt - List of import route target. type: list member_path: vrf:vrf/import_rt:route_target more...
- route_target - Attribute: AA:NN|A.B.C.D:NN type: str required: true more...
- leak_target - Target VRF table. type: list member_path: vrf:vrf/leak_target:vrf more...
- interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...
- route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...
- vrf - Target VRF ID (0 - 251). type: str required: true more...
- rd - Route Distinguisher: AA:NN|A.B.C.D:NN. type: str more...
- role - VRF role. type: str choices: standalone, ce, pe more...
- vrf - Origin VRF ID (0 - 251). type: str required: true more...
- vrf_leak - BGP VRF leaking table. type: list member_path: vrf_leak:vrf more...
- target - Target VRF table. type: list member_path: vrf_leak:vrf/target:vrf more...
- interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...
- route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...
- vrf - Target VRF ID (0 - 31). type: str required: true more...
- vrf - Origin VRF ID (0 - 31). type: str required: true more...
- vrf_leak6 - BGP IPv6 VRF leaking table. type: list member_path: vrf_leak6:vrf more...
- target - Target VRF table. type: list member_path: vrf_leak6:vrf/target:vrf more...
- interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...
- route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...
- vrf - Target VRF ID (0 - 31). type: str required: true more...
- vrf - Origin VRF ID (0 - 31). type: str required: true more...
- vrf6 - BGP IPv6 VRF leaking table. type: list member_path: vrf6:vrf more...
- export_rt - List of export route target. type: list member_path: vrf6:vrf/export_rt:route_target more...
- route_target - Attribute: AA:NN|A.B.C.D:NN. type: str required: true more...
- import_route_map - Import route map. Source router.route-map.name. type: str more...
- import_rt - List of import route target. type: list member_path: vrf6:vrf/import_rt:route_target more...
- route_target - Attribute: AA:NN|A.B.C.D:NN type: str required: true more...
- leak_target - Target VRF table. type: list member_path: vrf6:vrf/leak_target:vrf more...
- interface - Interface which is used to leak routes to target VRF. Source system.interface.name. type: str more...
- route_map - Route map of VRF leaking. Source router.route-map.name. type: str more...
- vrf - Target VRF ID (0 - 251). type: str required: true more...
- rd - Route Distinguisher: AA:NN|A.B.C.D:NN. type: str more...
- role - VRF role. type: str choices: standalone, ce, pe more...
- vrf - Origin VRF ID (0 - 251). type: str required: true more...
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_select_vpnv6: "2"
additional_path_select6: "2"
additional_path_vpnv4: "enable"
additional_path_vpnv6: "enable"
additional_path6: "enable"
admin_distance:
-
distance: "0"
id: "13"
neighbour_prefix: "<your_own_value>"
route_list: "<your_own_value> (source router.access-list.name)"
aggregate_address:
-
as_set: "enable"
id: "18"
prefix: "<your_own_value>"
summary_only: "enable"
aggregate_address6:
-
as_set: "enable"
id: "23"
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"
activate_vpnv6: "enable"
activate6: "enable"
additional_path: "send"
additional_path_vpnv4: "send"
additional_path_vpnv6: "send"
additional_path6: "send"
adv_additional_path: "2"
adv_additional_path_vpnv4: "2"
adv_additional_path_vpnv6: "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_enable_vpnv6: "enable"
allowas_in_enable6: "enable"
allowas_in_evpn: "3"
allowas_in_vpnv4: "3"
allowas_in_vpnv6: "3"
allowas_in6: "3"
as_override: "enable"
as_override6: "enable"
attribute_unchanged: "as-path"
attribute_unchanged_vpnv4: "as-path"
attribute_unchanged_vpnv6: "as-path"
attribute_unchanged6: "as-path"
auth_options: "<your_own_value> (source router.key-chain.name)"
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_restart_vpnv6: "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_112 (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_117 (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_in_vpnv6: "<your_own_value> (source router.access-list6.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_out_vpnv6: "<your_own_value> (source router.access-list6.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_in_vpnv6: "<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_out_vpnv6: "<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_threshold_vpnv6: "75"
maximum_prefix_threshold6: "75"
maximum_prefix_vpnv4: "0"
maximum_prefix_vpnv6: "0"
maximum_prefix_warning_only: "enable"
maximum_prefix_warning_only_evpn: "enable"
maximum_prefix_warning_only_vpnv4: "enable"
maximum_prefix_warning_only_vpnv6: "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_self_vpnv6: "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_in_vpnv6: "<your_own_value> (source router.prefix-list6.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_out_vpnv6: "<your_own_value> (source router.prefix-list6.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_as_vpnv6: "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_in_vpnv6: "<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_out_vpnv6: "<your_own_value> (source router.route-map.name)"
route_map_out_vpnv6_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_client_vpnv6: "enable"
route_reflector_client6: "enable"
route_server_client: "enable"
route_server_client_evpn: "enable"
route_server_client_vpnv4: "enable"
route_server_client_vpnv6: "enable"
route_server_client6: "enable"
send_community: "standard"
send_community_evpn: "standard"
send_community_vpnv4: "standard"
send_community_vpnv6: "standard"
send_community6: "standard"
shutdown: "enable"
soft_reconfiguration: "enable"
soft_reconfiguration_evpn: "enable"
soft_reconfiguration_vpnv4: "enable"
soft_reconfiguration_vpnv6: "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"
activate_vpnv6: "enable"
activate6: "enable"
additional_path: "send"
additional_path_vpnv4: "send"
additional_path_vpnv6: "send"
additional_path6: "send"
adv_additional_path: "2"
adv_additional_path_vpnv4: "2"
adv_additional_path_vpnv6: "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_enable_vpnv6: "enable"
allowas_in_enable6: "enable"
allowas_in_evpn: "3"
allowas_in_vpnv4: "3"
allowas_in_vpnv6: "3"
allowas_in6: "3"
as_override: "enable"
as_override6: "enable"
attribute_unchanged: "as-path"
attribute_unchanged_vpnv4: "as-path"
attribute_unchanged_vpnv6: "as-path"
attribute_unchanged6: "as-path"
auth_options: "<your_own_value> (source router.key-chain.name)"
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_restart_vpnv6: "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_in_vpnv6: "<your_own_value> (source router.access-list6.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_out_vpnv6: "<your_own_value> (source router.access-list6.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_in_vpnv6: "<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_out_vpnv6: "<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_threshold_vpnv6: "75"
maximum_prefix_threshold6: "75"
maximum_prefix_vpnv4: "0"
maximum_prefix_vpnv6: "0"
maximum_prefix_warning_only: "enable"
maximum_prefix_warning_only_evpn: "enable"
maximum_prefix_warning_only_vpnv4: "enable"
maximum_prefix_warning_only_vpnv6: "enable"
maximum_prefix_warning_only6: "enable"
maximum_prefix6: "0"
name: "default_name_320"
next_hop_self: "enable"
next_hop_self_rr: "enable"
next_hop_self_rr6: "enable"
next_hop_self_vpnv4: "enable"
next_hop_self_vpnv6: "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_in_vpnv6: "<your_own_value> (source router.prefix-list6.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_out_vpnv6: "<your_own_value> (source router.prefix-list6.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_as_vpnv6: "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_in_vpnv6: "<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_out_vpnv6: "<your_own_value> (source router.route-map.name)"
route_map_out_vpnv6_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_client_vpnv6: "enable"
route_reflector_client6: "enable"
route_server_client: "enable"
route_server_client_evpn: "enable"
route_server_client_vpnv4: "enable"
route_server_client_vpnv6: "enable"
route_server_client6: "enable"
send_community: "standard"
send_community_evpn: "standard"
send_community_vpnv4: "standard"
send_community_vpnv6: "standard"
send_community6: "standard"
shutdown: "enable"
soft_reconfiguration: "enable"
soft_reconfiguration_evpn: "enable"
soft_reconfiguration_vpnv4: "enable"
soft_reconfiguration_vpnv6: "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: "388"
max_neighbor_num: "0"
neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
prefix: "<your_own_value>"
neighbor_range6:
-
id: "393"
max_neighbor_num: "0"
neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
prefix6: "<your_own_value>"
network:
-
backdoor: "enable"
id: "399"
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: "406"
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_413"
route_map: "<your_own_value> (source router.route-map.name)"
status: "enable"
redistribute6:
-
name: "default_name_417"
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:
-
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>"
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.