BGP IPv4

Location in GUI: Devices » Device Management » Device » Routing » BGP » IPv4

Diagram

Classes

vrfs (fmc.domains.devices.devices)

Name	Type	Constraint	Mandatory	Default Value
bgp	Class	`[bgp]`	No

bgp (fmc.domains.devices.devices.vrfs)

Name	Type	Constraint	Mandatory	Default Value
ipv4_aggregate_addresses	List	`[ipv4_aggregate_addresses]`	No
ipv4_auto_summary	Boolean	`true`, `false`	No
ipv4_redistribute_ibgp_into_igp	Boolean	`true`, `false`	No
ipv4_suppress_inactive_routes	Boolean	`true`, `false`	No
ipv4_default_information_orginate	Boolean	`true`, `false`	No
ipv4_external_distance	Integer	min: `1`, max: `255`	No	`20`
ipv4_filterings	List	`[ipv4_filterings]`	No
ipv4_number_of_ebgp_paths	Integer	min: `1`, max: `8`	No	`1`
ipv4_number_of_ibgp_paths	Integer	min: `1`, max: `8`	No	`1`
ipv4_internal_distance	Integer	min: `1`, max: `255`	No	`200`
ipv4_learned_route_map	String		No
ipv4_local_distance	Integer	min: `1`, max: `255`	No	`200`
ipv4_neighbors	List	`[ipv4_neighbors]`	No
ipv4_networks	List	`[ipv4_networks]`	No
ipv4_redistributions	List	`[ipv4_redistributions]`	No
ipv4_route_injections	List	`[ipv4_route_injections]`	No
ipv4_synchronization	Boolean	`true`, `false`	No

ipv4_aggregate_addresses (fmc.domains.devices.devices.vrfs.bgp)

Name	Type	Constraint	Mandatory
advertise_map	String		No
attribute_map	String		No
filter	Boolean	`true`, `false`	No
generate_as	Boolean	`true`, `false`	No
network	String		No
suppress_map	String		No

ipv4_filterings (fmc.domains.devices.devices.vrfs.bgp)

Name	Type	Constraint	Mandatory
access_list	String		No
direction	Choice	`incomingroutefilter`, `outgoingroutefilter`	No
process_id	String		No
protocol	Choice	`CONNECTED`, `BGP`, `OSPF`, `RIP`, `STATIC`	No

ipv4_neighbors (fmc.domains.devices.devices.vrfs.bgp)

Name	Type	Constraint	Mandatory
enable_address	Boolean	`true`, `false`	No
address	IP		No
authentication_password	String		No
bfd_fallover	Choice	`SINGLE_HOP`, `MULTI_HOP`, `AUTO_DETECT_HOP`, `NONE`	No
customized_accept_both_as	Boolean	`true`, `false`	No
customized_local_as_number	String		No
customized_no_prepend	Boolean	`true`, `false`	No
customized_replace_as	Boolean	`true`, `false`	No
description	String		No
disable_connection_verification	Boolean	`true`, `false`	No
filter_access_lists	List	`[filter_access_lists]`	No
filter_as_paths	List	`[filter_as_paths]`	No
filter_maximum_prefixes	Integer	min: `1`, max: `2147483647`	No
filter_prefix_lists	List	`[filter_prefix_lists]`	No
filter_restart_interval	Integer	min: `1`, max: `65535`	No
filter_route_maps	List	`[filter_route_maps]`	No
filter_threshold_value	Integer	min: `1`, max: `100`	No
filter_warning_only	Boolean	`true`, `false`	No
routes_generate_default_route_map	String		No
hold_time	Integer	min: `3`, max: `65535`	No
keepalive_interval	Integer	min: `0`, max: `65535`	No
max_hop_count	Integer	min: `1`, max: `255`	No
minimum_hold_time	Integer	min: `3`, max: `65535`	No
next_hop_self	Boolean	`true`, `false`	No
remote_as	String		No
routes_advertise_maps	List	`[routes_advertise_maps]`	No
routes_advertisement_interval	Integer	min: `0`, max: `600`	No
routes_remove_private_as	Boolean	`true`, `false`	No
send_community_attribute	Boolean	`true`, `false`	No
shutdown_administratively	Boolean	`true`, `false`	No
tcp_path_mtu_discovery	Boolean	`true`, `false`	No
tcp_transport_mode	Boolean	`true`, `false`	No
version	Choice	`0`, `4`	No
weight	Integer	min: `0`, max: `65535`	No
update_source_interface	String		No

ipv4_networks (fmc.domains.devices.devices.vrfs.bgp)

Name	Type	Constraint	Mandatory	Default Value
network	String		No
route_map	String		No

ipv4_redistributions (fmc.domains.devices.devices.vrfs.bgp)

Name	Type	Constraint	Mandatory
match_external1	Boolean	`true`, `false`	No
match_external2	Boolean	`true`, `false`	No
match_internal	Boolean	`true`, `false`	No
match_nssa_external1	Boolean	`true`, `false`	No
match_nssa_external2	Boolean	`true`, `false`	No
metric	Integer	min: `0`, max: `4294967295`	No
process_id	String		No
route_map	String		No
source_protocol	Choice	`RedistributeConnected`, `RedistributeStatic`, `RedistributeOSPF`, `RedistributeEIGRP`	Yes

ipv4_route_injections (fmc.domains.devices.devices.vrfs.bgp)

Name	Type	Constraint	Mandatory
exist_route_map	String		No
inject_route_map	String		No
inherit_attributes	Boolean	`true`, `false`	No

filter_access_lists (fmc.domains.devices.devices.vrfs.bgp.ipv4_neighbors)

Name	Type	Constraint	Mandatory	Default Value
access_list	String		No
update_direction	Choice	`IN`, `OUT`	No

filter_as_paths (fmc.domains.devices.devices.vrfs.bgp.ipv4_neighbors)

Name	Type	Constraint	Mandatory	Default Value
as_path	String		No
update_direction	Choice	`IN`, `OUT`	No

filter_prefix_lists (fmc.domains.devices.devices.vrfs.bgp.ipv4_neighbors)

Name	Type	Constraint	Mandatory	Default Value
prefix_list	String		No
update_direction	Choice	`IN`, `OUT`	No

filter_route_maps (fmc.domains.devices.devices.vrfs.bgp.ipv4_neighbors)

Name	Type	Constraint	Mandatory	Default Value
route_map	String		No
update_direction	Choice	`IN`, `OUT`	No

routes_advertise_maps (fmc.domains.devices.devices.vrfs.bgp.ipv4_neighbors)

Name	Type	Constraint	Mandatory
advertise_map	String		Yes
exist_nonexist_map	String		No
use_exist_map	Boolean	`true`, `false`	No

Examples

Prerequisites:

fmc:
  domains:
    - name: Global
      devices:
        devices:
          - name: MyDeviceName1
            host: 10.62.158.201
            registration_key: cisco123
            access_policy: MyAccessPolicyName1
            deploy: true
            licenses:
            - ESSENTIALS
            performance_tier: FTDv5
            vrfs:
              - name: Global

BGP IPv4:

fmc:
  domains:
    - name: Global
      devices:
        devices:
          - name: MyDeviceName1
            vrfs:
              - name: Global
                bgp:
                  ipv4_default_information_orginate: true
                  ipv4_neighbors:
                  - enable_address: true
                    address: 10.0.5.2
                    bfd_fallover: SINGLE_HOP
                    remote_as: "64600"
                    shutdown_administratively: false