fmgd_router_bgp_neighborgroup – BGP neighbor group table.
Added in version 1.0.0.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- router_bgp_neighborgroup - BGP neighbor group table. type: dict
- activate Enable/disable address family ipv4 for this neighbor. type: str choices: [disable, enable] more...
- activate_evpn (Alias name: activate-evpn) Enable/disable address family l2vpn evpn for this neighbor. type: str choices: [disable, enable] more...
- activate_vpnv4 (Alias name: activate-vpnv4) Enable/disable address family vpnv4 for this neighbor. type: str choices: [disable, enable] more...
- activate_vpnv6 (Alias name: activate-vpnv6) Enable/disable address family vpnv6 for this neighbor. type: str choices: [disable, enable] more...
- activate6 Enable/disable address family ipv6 for this neighbor. type: str choices: [disable, enable] more...
- additional_path (Alias name: additional-path) Enable/disable ipv4 additional-path capability. type: str choices: [send, receive, both, disable] more...
- additional_path_vpnv4 (Alias name: additional-path-vpnv4) Enable/disable vpnv4 additional-path capability. type: str choices: [send, receive, both, disable] more...
- additional_path_vpnv6 (Alias name: additional-path-vpnv6) Enable/disable vpnv6 additional-path capability. type: str choices: [send, receive, both, disable] more...
- additional_path6 (Alias name: additional-path6) Enable/disable ipv6 additional-path capability. type: str choices: [send, receive, both, disable] more...
- adv_additional_path (Alias name: adv-additional-path) Number of ipv4 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path_vpnv4 (Alias name: adv-additional-path-vpnv4) Number of vpnv4 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path_vpnv6 (Alias name: adv-additional-path-vpnv6) Number of vpnv6 additional paths that can be advertised to this neighbor. type: int more...
- adv_additional_path6 (Alias name: adv-additional-path6) Number of ipv6 additional paths that can be advertised to this neighbor. type: int more...
- advertisement_interval (Alias name: advertisement-interval) Minimum interval (sec) between sending updates. type: int more...
- allowas_in (Alias name: allowas-in) Ipv4 the maximum number of occurrence of my as number allowed. type: int more...
- allowas_in_enable (Alias name: allowas-in-enable) Enable/disable ipv4 enable to allow my as in as path. type: str choices: [disable, enable] more...
- allowas_in_enable_evpn (Alias name: allowas-in-enable-evpn) Enable/disable to allow my as in as path for l2vpn evpn route. type: str choices: [disable, enable] more...
- allowas_in_enable_vpnv4 (Alias name: allowas-in-enable-vpnv4) Enable/disable to allow my as in as path for vpnv4 route. type: str choices: [disable, enable] more...
- allowas_in_enable_vpnv6 (Alias name: allowas-in-enable-vpnv6) Enable/disable use of my as in as path for vpnv6 route. type: str choices: [disable, enable] more...
- allowas_in_enable6 (Alias name: allowas-in-enable6) Enable/disable ipv6 enable to allow my as in as path. type: str choices: [disable, enable] more...
- allowas_in_evpn (Alias name: allowas-in-evpn) The maximum number of occurrence of my as number allowed for l2vpn evpn route. type: int more...
- allowas_in_vpnv4 (Alias name: allowas-in-vpnv4) The maximum number of occurrence of my as number allowed for vpnv4 route. type: int more...
- allowas_in_vpnv6 (Alias name: allowas-in-vpnv6) The maximum number of occurrence of my as number allowed for vpnv6 route. type: int more...
- allowas_in6 (Alias name: allowas-in6) Ipv6 the maximum number of occurrence of my as number allowed. type: int more...
- as_override (Alias name: as-override) Enable/disable replace peer as with own as for ipv4. type: str choices: [disable, enable] more...
- as_override6 (Alias name: as-override6) Enable/disable replace peer as with own as for ipv6. type: str choices: [disable, enable] more...
- attribute_unchanged (Alias name: attribute-unchanged) Ipv4 list of attributes that should be unchanged. type: list choices: [as-path, med, next-hop] more...
- attribute_unchanged_vpnv4 (Alias name: 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 (Alias name: 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 (Alias name: attribute-unchanged6) Ipv6 list of attributes that should be unchanged. type: list choices: [as-path, med, next-hop] more...
- auth_options (Alias name: auth-options) Key-chain name for tcp authentication options. type: list more...
- bfd Enable/disable bfd for this neighbor. type: str choices: [disable, enable] more...
- capability_default_originate (Alias name: capability-default-originate) Enable/disable advertise default ipv4 route to this neighbor. type: str choices: [disable, enable] more...
- capability_default_originate6 (Alias name: capability-default-originate6) Enable/disable advertise default ipv6 route to this neighbor. type: str choices: [disable, enable] more...
- capability_dynamic (Alias name: capability-dynamic) Enable/disable advertise dynamic capability to this neighbor. type: str choices: [disable, enable] more...
- capability_graceful_restart (Alias name: capability-graceful-restart) Enable/disable advertise ipv4 graceful restart capability to this neighbor. type: str choices: [disable, enable] more...
- capability_graceful_restart_evpn (Alias name: capability-graceful-restart-evpn) Enable/disable advertisement of l2vpn evpn graceful restart capability to this neighbor. type: str choices: [disable, enable] more...
- capability_graceful_restart_vpnv4 (Alias name: capability-graceful-restart-vpnv4) Enable/disable advertise vpnv4 graceful restart capability to this neighbor. type: str choices: [disable, enable] more...
- capability_graceful_restart_vpnv6 (Alias name: capability-graceful-restart-vpnv6) Enable/disable advertisement of vpnv6 graceful restart capability to this neighbor. type: str choices: [disable, enable] more...
- capability_graceful_restart6 (Alias name: capability-graceful-restart6) Enable/disable advertise ipv6 graceful restart capability to this neighbor. type: str choices: [disable, enable] more...
- capability_orf (Alias name: capability-orf) Accept/send ipv4 orf lists to/from this neighbor. type: str choices: [none, send, receive, both] more...
- capability_orf6 (Alias name: capability-orf6) Accept/send ipv6 orf lists to/from this neighbor. type: str choices: [none, send, receive, both] more...
- capability_route_refresh (Alias name: capability-route-refresh) Enable/disable advertise route refresh capability to this neighbor. type: str choices: [disable, enable] more...
- connect_timer (Alias name: connect-timer) Interval (sec) for connect timer. type: int more...
- default_originate_routemap (Alias name: default-originate-routemap) Route map to specify criteria to originate ipv4 default. type: list more...
- default_originate_routemap6 (Alias name: default-originate-routemap6) Route map to specify criteria to originate ipv6 default. type: list more...
- description Description. type: str more...
- distribute_list_in (Alias name: distribute-list-in) Filter for ipv4 updates from this neighbor. type: list more...
- distribute_list_in_vpnv4 (Alias name: distribute-list-in-vpnv4) Filter for vpnv4 updates from this neighbor. type: list more...
- distribute_list_in_vpnv6 (Alias name: distribute-list-in-vpnv6) Filter for vpnv6 updates from this neighbor. type: list more...
- distribute_list_in6 (Alias name: distribute-list-in6) Filter for ipv6 updates from this neighbor. type: list more...
- distribute_list_out (Alias name: distribute-list-out) Filter for ipv4 updates to this neighbor. type: list more...
- distribute_list_out_vpnv4 (Alias name: distribute-list-out-vpnv4) Filter for vpnv4 updates to this neighbor. type: list more...
- distribute_list_out_vpnv6 (Alias name: distribute-list-out-vpnv6) Filter for vpnv6 updates to this neighbor. type: list more...
- distribute_list_out6 (Alias name: distribute-list-out6) Filter for ipv6 updates to this neighbor. type: list more...
- dont_capability_negotiate (Alias name: dont-capability-negotiate) Do not negotiate capabilities with this neighbor. type: str choices: [disable, enable] more...
- ebgp_enforce_multihop (Alias name: ebgp-enforce-multihop) Enable/disable allow multi-hop ebgp neighbors. type: str choices: [disable, enable] more...
- ebgp_multihop_ttl (Alias name: ebgp-multihop-ttl) Ebgp multihop ttl for this peer. type: int more...
- filter_list_in (Alias name: filter-list-in) Bgp filter for ipv4 inbound routes. type: list more...
- filter_list_in_vpnv4 (Alias name: filter-list-in-vpnv4) Bgp filter for vpnv4 inbound routes. type: list more...
- filter_list_in_vpnv6 (Alias name: filter-list-in-vpnv6) Bgp filter for vpnv6 inbound routes. type: list more...
- filter_list_in6 (Alias name: filter-list-in6) Bgp filter for ipv6 inbound routes. type: list more...
- filter_list_out (Alias name: filter-list-out) Bgp filter for ipv4 outbound routes. type: list more...
- filter_list_out_vpnv4 (Alias name: filter-list-out-vpnv4) Bgp filter for vpnv4 outbound routes. type: list more...
- filter_list_out_vpnv6 (Alias name: filter-list-out-vpnv6) Bgp filter for vpnv6 outbound routes. type: list more...
- filter_list_out6 (Alias name: filter-list-out6) Bgp filter for ipv6 outbound routes. type: list more...
- holdtime_timer (Alias name: holdtime-timer) Interval (sec) before peer considered dead. type: int more...
- interface Specify outgoing interface for peer connection. type: list more...
- keep_alive_timer (Alias name: keep-alive-timer) Keep alive timer interval (sec). type: int more...
- link_down_failover (Alias name: link-down-failover) Enable/disable failover upon link down. type: str choices: [disable, enable] more...
- local_as (Alias name: local-as) Local as number of neighbor. type: int more...
- local_as_no_prepend (Alias name: local-as-no-prepend) Do not prepend local-as to incoming updates. type: str choices: [disable, enable] more...
- local_as_replace_as (Alias name: local-as-replace-as) Replace real as with local-as in outgoing updates. type: str choices: [disable, enable] more...
- maximum_prefix (Alias name: maximum-prefix) Maximum number of ipv4 prefixes to accept from this peer. type: int more...
- maximum_prefix_evpn (Alias name: maximum-prefix-evpn) Maximum number of l2vpn evpn prefixes to accept from this peer. type: int more...
- maximum_prefix_threshold (Alias name: maximum-prefix-threshold) Maximum ipv4 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_evpn (Alias name: maximum-prefix-threshold-evpn) Maximum l2vpn evpn prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_vpnv4 (Alias name: maximum-prefix-threshold-vpnv4) Maximum vpnv4 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold_vpnv6 (Alias name: maximum-prefix-threshold-vpnv6) Maximum vpnv6 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_threshold6 (Alias name: maximum-prefix-threshold6) Maximum ipv6 prefix threshold value (1 - 100 percent). type: int more...
- maximum_prefix_vpnv4 (Alias name: maximum-prefix-vpnv4) Maximum number of vpnv4 prefixes to accept from this peer. type: int more...
- maximum_prefix_vpnv6 (Alias name: maximum-prefix-vpnv6) Maximum number of vpnv6 prefixes to accept from this peer. type: int more...
- maximum_prefix_warning_only (Alias name: maximum-prefix-warning-only) Enable/disable ipv4 only give warning message when limit is exceeded. type: str choices: [disable, enable] more...
- maximum_prefix_warning_only_evpn (Alias name: maximum-prefix-warning-only-evpn) Enable/disable only sending warning message when exceeding limit of l2vpn evpn routes. type: str choices: [disable, enable] more...
- maximum_prefix_warning_only_vpnv4 (Alias name: maximum-prefix-warning-only-vpnv4) Enable/disable only giving warning message when limit is exceeded for vpnv4 routes. type: str choices: [disable, enable] more...
- maximum_prefix_warning_only_vpnv6 (Alias name: maximum-prefix-warning-only-vpnv6) Enable/disable warning message when limit is exceeded for vpnv6 routes. type: str choices: [disable, enable] more...
- maximum_prefix_warning_only6 (Alias name: maximum-prefix-warning-only6) Enable/disable ipv6 only give warning message when limit is exceeded. type: str choices: [disable, enable] more...
- maximum_prefix6 (Alias name: maximum-prefix6) Maximum number of ipv6 prefixes to accept from this peer. type: int more...
- name Neighbor group name. type: str more...
- next_hop_self (Alias name: next-hop-self) Enable/disable ipv4 next-hop calculation for this neighbor. type: str choices: [disable, enable] more...
- next_hop_self_rr (Alias name: next-hop-self-rr) Enable/disable setting nexthops address to interfaces ipv4 address for route-reflector routes. type: str choices: [disable, enable] more...
- next_hop_self_rr6 (Alias name: next-hop-self-rr6) Enable/disable setting nexthops address to interfaces ipv6 address for route-reflector routes. type: str choices: [disable, enable] more...
- next_hop_self_vpnv4 (Alias name: next-hop-self-vpnv4) Enable/disable setting vpnv4 next-hop to interfaces ip address for this neighbor. type: str choices: [disable, enable] more...
- next_hop_self_vpnv6 (Alias name: next-hop-self-vpnv6) Enable/disable use of outgoing interfaces ip address as vpnv6 next-hop for this neighbor. type: str choices: [disable, enable] more...
- next_hop_self6 (Alias name: next-hop-self6) Enable/disable ipv6 next-hop calculation for this neighbor. type: str choices: [disable, enable] more...
- override_capability (Alias name: override-capability) Enable/disable override result of capability negotiation. type: str choices: [disable, enable] more...
- passive Enable/disable sending of open messages to this neighbor. type: str choices: [disable, enable] more...
- password Password used in md5 authentication. type: list more...
- prefix_list_in (Alias name: prefix-list-in) Ipv4 inbound filter for updates from this neighbor. type: list more...
- prefix_list_in_vpnv4 (Alias name: prefix-list-in-vpnv4) Inbound filter for vpnv4 updates from this neighbor. type: list more...
- prefix_list_in_vpnv6 (Alias name: prefix-list-in-vpnv6) Inbound filter for vpnv6 updates from this neighbor. type: list more...
- prefix_list_in6 (Alias name: prefix-list-in6) Ipv6 inbound filter for updates from this neighbor. type: list more...
- prefix_list_out (Alias name: prefix-list-out) Ipv4 outbound filter for updates to this neighbor. type: list more...
- prefix_list_out_vpnv4 (Alias name: prefix-list-out-vpnv4) Outbound filter for vpnv4 updates to this neighbor. type: list more...
- prefix_list_out_vpnv6 (Alias name: prefix-list-out-vpnv6) Outbound filter for vpnv6 updates to this neighbor. type: list more...
- prefix_list_out6 (Alias name: prefix-list-out6) Ipv6 outbound filter for updates to this neighbor. type: list more...
- remote_as (Alias name: remote-as) As number of neighbor. type: int more...
- remote_as_filter (Alias name: remote-as-filter) Bgp filter for remote as. type: list more...
- remove_private_as (Alias name: remove-private-as) Enable/disable remove private as number from ipv4 outbound updates. type: str choices: [disable, enable] more...
- remove_private_as_evpn (Alias name: remove-private-as-evpn) Enable/disable removing private as number from l2vpn evpn outbound updates. type: str choices: [disable, enable] more...
- remove_private_as_vpnv4 (Alias name: remove-private-as-vpnv4) Enable/disable remove private as number from vpnv4 outbound updates. type: str choices: [disable, enable] more...
- remove_private_as_vpnv6 (Alias name: remove-private-as-vpnv6) Enable/disable to remove private as number from vpnv6 outbound updates. type: str choices: [disable, enable] more...
- remove_private_as6 (Alias name: remove-private-as6) Enable/disable remove private as number from ipv6 outbound updates. type: str choices: [disable, enable] more...
- restart_time (Alias name: restart-time) Graceful restart delay time (sec, 0 = global default). type: int more...
- retain_stale_time (Alias name: retain-stale-time) Time to retain stale routes. type: int more...
- route_map_in (Alias name: route-map-in) Ipv4 inbound route map filter. type: list more...
- route_map_in_evpn (Alias name: route-map-in-evpn) L2vpn evpn inbound route map filter. type: list more...
- route_map_in_vpnv4 (Alias name: route-map-in-vpnv4) Vpnv4 inbound route map filter. type: list more...
- route_map_in_vpnv6 (Alias name: route-map-in-vpnv6) Vpnv6 inbound route map filter. type: list more...
- route_map_in6 (Alias name: route-map-in6) Ipv6 inbound route map filter. type: list more...
- route_map_out (Alias name: route-map-out) Ipv4 outbound route map filter. type: list more...
- route_map_out_evpn (Alias name: route-map-out-evpn) L2vpn evpn outbound route map filter. type: list more...
- route_map_out_preferable (Alias name: route-map-out-preferable) Ipv4 outbound route map filter if the peer is preferred. type: list more...
- route_map_out_vpnv4 (Alias name: route-map-out-vpnv4) Vpnv4 outbound route map filter. type: list more...
- route_map_out_vpnv4_preferable (Alias name: route-map-out-vpnv4-preferable) Vpnv4 outbound route map filter if the peer is preferred. type: list more...
- route_map_out_vpnv6 (Alias name: route-map-out-vpnv6) Vpnv6 outbound route map filter. type: list more...
- route_map_out_vpnv6_preferable (Alias name: route-map-out-vpnv6-preferable) Vpnv6 outbound route map filter if this neighbor is preferred. type: list more...
- route_map_out6 (Alias name: route-map-out6) Ipv6 outbound route map filter. type: list more...
- route_map_out6_preferable (Alias name: route-map-out6-preferable) Ipv6 outbound route map filter if the peer is preferred. type: list more...
- route_reflector_client (Alias name: route-reflector-client) Enable/disable ipv4 as route reflector client. type: str choices: [disable, enable] more...
- route_reflector_client_evpn (Alias name: route-reflector-client-evpn) Enable/disable l2vpn evpn as route reflector client for this neighbor. type: str choices: [disable, enable] more...
- route_reflector_client_vpnv4 (Alias name: route-reflector-client-vpnv4) Enable/disable vpnv4 as route reflector client for this neighbor. type: str choices: [disable, enable] more...
- route_reflector_client_vpnv6 (Alias name: route-reflector-client-vpnv6) Enable/disable vpnv6 as route reflector client for this neighbor. type: str choices: [disable, enable] more...
- route_reflector_client6 (Alias name: route-reflector-client6) Enable/disable ipv6 as route reflector client. type: str choices: [disable, enable] more...
- route_server_client (Alias name: route-server-client) Enable/disable ipv4 as route server client. type: str choices: [disable, enable] more...
- route_server_client_evpn (Alias name: route-server-client-evpn) Enable/disable l2vpn evpn as route server client for this neighbor. type: str choices: [disable, enable] more...
- route_server_client_vpnv4 (Alias name: route-server-client-vpnv4) Enable/disable vpnv4 as route server client for this neighbor. type: str choices: [disable, enable] more...
- route_server_client_vpnv6 (Alias name: route-server-client-vpnv6) Enable/disable vpnv6 as route server client for this neighbor. type: str choices: [disable, enable] more...
- route_server_client6 (Alias name: route-server-client6) Enable/disable ipv6 as route server client. type: str choices: [disable, enable] more...
- send_community (Alias name: send-community) Ipv4 send community attribute to neighbor. type: str choices: [disable, standard, extended, both] more...
- send_community_evpn (Alias name: send-community-evpn) Enable/disable sending community attribute to neighbor for l2vpn evpn address family. type: str choices: [disable, standard, extended, both] more...
- send_community_vpnv4 (Alias name: send-community-vpnv4) Send community attribute to neighbor for vpnv4 address family. type: str choices: [disable, standard, extended, both] more...
- send_community_vpnv6 (Alias name: send-community-vpnv6) Enable/disable sending community attribute to this neighbor for vpnv6 address family. type: str choices: [disable, standard, extended, both] more...
- send_community6 (Alias name: send-community6) Ipv6 send community attribute to neighbor. type: str choices: [disable, standard, extended, both] more...
- shutdown Enable/disable shutdown this neighbor. type: str choices: [disable, enable] more...
- soft_reconfiguration (Alias name: soft-reconfiguration) Enable/disable allow ipv4 inbound soft reconfiguration. type: str choices: [disable, enable] more...
- soft_reconfiguration_evpn (Alias name: soft-reconfiguration-evpn) Enable/disable l2vpn evpn inbound soft reconfiguration. type: str choices: [disable, enable] more...
- soft_reconfiguration_vpnv4 (Alias name: soft-reconfiguration-vpnv4) Enable/disable allow vpnv4 inbound soft reconfiguration. type: str choices: [disable, enable] more...
- soft_reconfiguration_vpnv6 (Alias name: soft-reconfiguration-vpnv6) Enable/disable vpnv6 inbound soft reconfiguration. type: str choices: [disable, enable] more...
- soft_reconfiguration6 (Alias name: soft-reconfiguration6) Enable/disable allow ipv6 inbound soft reconfiguration. type: str choices: [disable, enable] more...
- stale_route (Alias name: stale-route) Enable/disable stale route after neighbor down. type: str choices: [disable, enable] more...
- strict_capability_match (Alias name: strict-capability-match) Enable/disable strict capability matching. type: str choices: [disable, enable] more...
- unsuppress_map (Alias name: unsuppress-map) Ipv4 route map to selectively unsuppress suppressed routes. type: list more...
- unsuppress_map6 (Alias name: unsuppress-map6) Ipv6 route map to selectively unsuppress suppressed routes. type: list more...
- update_source (Alias name: update-source) Interface to use as source ip/ipv6 address of tcp connections. type: list more...
- weight Neighbor weight. type: int more...
- rr_attr_allow_change (Alias name: rr-attr-allow-change) Enable/disable allowing change of route attributes when advertising to ipv4 route reflector clients. type: str choices: [disable, enable] more...
- rr_attr_allow_change_evpn (Alias name: rr-attr-allow-change-evpn) Enable/disable allowing change of route attributes when advertising to l2vpn evpn route reflector clients. type: str choices: [disable, enable] more...
- rr_attr_allow_change_vpnv4 (Alias name: rr-attr-allow-change-vpnv4) Enable/disable allowing change of route attributes when advertising to vpnv4 route reflector clients. type: str choices: [disable, enable] more...
- rr_attr_allow_change_vpnv6 (Alias name: rr-attr-allow-change-vpnv6) Enable/disable allowing change of route attributes when advertising to vpnv6 route reflector clients. type: str choices: [disable, enable] more...
- rr_attr_allow_change6 (Alias name: rr-attr-allow-change6) Enable/disable allowing change of route attributes when advertising to ipv6 route reflector clients. type: str choices: [disable, enable] more...
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state: present directive.
To delete an object, use state: absent directive
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: BGP neighbor group table.
fortinet.fmgdevice.fmgd_router_bgp_neighborgroup:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
router_bgp_neighborgroup:
name: "your value" # Required variable, string
# activate: <value in [disable, enable]>
# activate_evpn: <value in [disable, enable]>
# activate_vpnv4: <value in [disable, enable]>
# activate_vpnv6: <value in [disable, enable]>
# activate6: <value in [disable, enable]>
# additional_path: <value in [send, receive, both, ...]>
# additional_path_vpnv4: <value in [send, receive, both, ...]>
# additional_path_vpnv6: <value in [send, receive, both, ...]>
# additional_path6: <value in [send, receive, both, ...]>
# adv_additional_path: <integer>
# adv_additional_path_vpnv4: <integer>
# adv_additional_path_vpnv6: <integer>
# adv_additional_path6: <integer>
# advertisement_interval: <integer>
# allowas_in: <integer>
# allowas_in_enable: <value in [disable, enable]>
# allowas_in_enable_evpn: <value in [disable, enable]>
# allowas_in_enable_vpnv4: <value in [disable, enable]>
# allowas_in_enable_vpnv6: <value in [disable, enable]>
# allowas_in_enable6: <value in [disable, enable]>
# allowas_in_evpn: <integer>
# allowas_in_vpnv4: <integer>
# allowas_in_vpnv6: <integer>
# allowas_in6: <integer>
# as_override: <value in [disable, enable]>
# as_override6: <value in [disable, enable]>
# attribute_unchanged:
# - "as-path"
# - "med"
# - "next-hop"
# attribute_unchanged_vpnv4:
# - "as-path"
# - "med"
# - "next-hop"
# attribute_unchanged_vpnv6:
# - "as-path"
# - "med"
# - "next-hop"
# attribute_unchanged6:
# - "as-path"
# - "med"
# - "next-hop"
# auth_options: <list or string>
# bfd: <value in [disable, enable]>
# capability_default_originate: <value in [disable, enable]>
# capability_default_originate6: <value in [disable, enable]>
# capability_dynamic: <value in [disable, enable]>
# capability_graceful_restart: <value in [disable, enable]>
# capability_graceful_restart_evpn: <value in [disable, enable]>
# capability_graceful_restart_vpnv4: <value in [disable, enable]>
# capability_graceful_restart_vpnv6: <value in [disable, enable]>
# capability_graceful_restart6: <value in [disable, enable]>
# capability_orf: <value in [none, send, receive, ...]>
# capability_orf6: <value in [none, send, receive, ...]>
# capability_route_refresh: <value in [disable, enable]>
# connect_timer: <integer>
# default_originate_routemap: <list or string>
# default_originate_routemap6: <list or string>
# description: <string>
# distribute_list_in: <list or string>
# distribute_list_in_vpnv4: <list or string>
# distribute_list_in_vpnv6: <list or string>
# distribute_list_in6: <list or string>
# distribute_list_out: <list or string>
# distribute_list_out_vpnv4: <list or string>
# distribute_list_out_vpnv6: <list or string>
# distribute_list_out6: <list or string>
# dont_capability_negotiate: <value in [disable, enable]>
# ebgp_enforce_multihop: <value in [disable, enable]>
# ebgp_multihop_ttl: <integer>
# filter_list_in: <list or string>
# filter_list_in_vpnv4: <list or string>
# filter_list_in_vpnv6: <list or string>
# filter_list_in6: <list or string>
# filter_list_out: <list or string>
# filter_list_out_vpnv4: <list or string>
# filter_list_out_vpnv6: <list or string>
# filter_list_out6: <list or string>
# holdtime_timer: <integer>
# interface: <list or string>
# keep_alive_timer: <integer>
# link_down_failover: <value in [disable, enable]>
# local_as: <integer>
# local_as_no_prepend: <value in [disable, enable]>
# local_as_replace_as: <value in [disable, enable]>
# maximum_prefix: <integer>
# maximum_prefix_evpn: <integer>
# maximum_prefix_threshold: <integer>
# maximum_prefix_threshold_evpn: <integer>
# maximum_prefix_threshold_vpnv4: <integer>
# maximum_prefix_threshold_vpnv6: <integer>
# maximum_prefix_threshold6: <integer>
# maximum_prefix_vpnv4: <integer>
# maximum_prefix_vpnv6: <integer>
# maximum_prefix_warning_only: <value in [disable, enable]>
# maximum_prefix_warning_only_evpn: <value in [disable, enable]>
# maximum_prefix_warning_only_vpnv4: <value in [disable, enable]>
# maximum_prefix_warning_only_vpnv6: <value in [disable, enable]>
# maximum_prefix_warning_only6: <value in [disable, enable]>
# maximum_prefix6: <integer>
# next_hop_self: <value in [disable, enable]>
# next_hop_self_rr: <value in [disable, enable]>
# next_hop_self_rr6: <value in [disable, enable]>
# next_hop_self_vpnv4: <value in [disable, enable]>
# next_hop_self_vpnv6: <value in [disable, enable]>
# next_hop_self6: <value in [disable, enable]>
# override_capability: <value in [disable, enable]>
# passive: <value in [disable, enable]>
# password: <list or string>
# prefix_list_in: <list or string>
# prefix_list_in_vpnv4: <list or string>
# prefix_list_in_vpnv6: <list or string>
# prefix_list_in6: <list or string>
# prefix_list_out: <list or string>
# prefix_list_out_vpnv4: <list or string>
# prefix_list_out_vpnv6: <list or string>
# prefix_list_out6: <list or string>
# remote_as: <integer>
# remote_as_filter: <list or string>
# remove_private_as: <value in [disable, enable]>
# remove_private_as_evpn: <value in [disable, enable]>
# remove_private_as_vpnv4: <value in [disable, enable]>
# remove_private_as_vpnv6: <value in [disable, enable]>
# remove_private_as6: <value in [disable, enable]>
# restart_time: <integer>
# retain_stale_time: <integer>
# route_map_in: <list or string>
# route_map_in_evpn: <list or string>
# route_map_in_vpnv4: <list or string>
# route_map_in_vpnv6: <list or string>
# route_map_in6: <list or string>
# route_map_out: <list or string>
# route_map_out_evpn: <list or string>
# route_map_out_preferable: <list or string>
# route_map_out_vpnv4: <list or string>
# route_map_out_vpnv4_preferable: <list or string>
# route_map_out_vpnv6: <list or string>
# route_map_out_vpnv6_preferable: <list or string>
# route_map_out6: <list or string>
# route_map_out6_preferable: <list or string>
# route_reflector_client: <value in [disable, enable]>
# route_reflector_client_evpn: <value in [disable, enable]>
# route_reflector_client_vpnv4: <value in [disable, enable]>
# route_reflector_client_vpnv6: <value in [disable, enable]>
# route_reflector_client6: <value in [disable, enable]>
# route_server_client: <value in [disable, enable]>
# route_server_client_evpn: <value in [disable, enable]>
# route_server_client_vpnv4: <value in [disable, enable]>
# route_server_client_vpnv6: <value in [disable, enable]>
# route_server_client6: <value in [disable, enable]>
# send_community: <value in [disable, standard, extended, ...]>
# send_community_evpn: <value in [disable, standard, extended, ...]>
# send_community_vpnv4: <value in [disable, standard, extended, ...]>
# send_community_vpnv6: <value in [disable, standard, extended, ...]>
# send_community6: <value in [disable, standard, extended, ...]>
# shutdown: <value in [disable, enable]>
# soft_reconfiguration: <value in [disable, enable]>
# soft_reconfiguration_evpn: <value in [disable, enable]>
# soft_reconfiguration_vpnv4: <value in [disable, enable]>
# soft_reconfiguration_vpnv6: <value in [disable, enable]>
# soft_reconfiguration6: <value in [disable, enable]>
# stale_route: <value in [disable, enable]>
# strict_capability_match: <value in [disable, enable]>
# unsuppress_map: <list or string>
# unsuppress_map6: <list or string>
# update_source: <list or string>
# weight: <integer>
# rr_attr_allow_change: <value in [disable, enable]>
# rr_attr_allow_change_evpn: <value in [disable, enable]>
# rr_attr_allow_change_vpnv4: <value in [disable, enable]>
# rr_attr_allow_change_vpnv6: <value in [disable, enable]>
# rr_attr_allow_change6: <value in [disable, enable]>
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:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.