VRF

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

Diagram

Classes

devices (fmc.domains.devices)

Name	Type	Constraint	Mandatory	Default Value
vrfs	List	`[vrfs]`	No

vrfs (fmc.domains.devices.devices)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.+ -]{1,64}$`	Yes
description	String	max: `255`	No
bgp	Class	`[bgp]`	No
physical_interfaces	List	`[physical_interfaces]`	No
etherchannel_interfaces	List	`[etherchannel_interfaces]`	No
sub_interfaces	List	`[sub_interfaces]`	No
ipv4_static_routes	List	`[ipv4_static_routes]`	No
ipv6_static_routes	List	`[ipv6_static_routes]`	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

physical_interfaces (fmc.domains.devices.devices.vrfs)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
mode	Choice	`INLINE`, `PASSIVE`, `TAP`, `ERSPAN`, `NONE`, `SWITCHPORT`	No	`NONE`
active_mac_address	String	max: `17`	No
allow_full_fragment_reassembly	Boolean	`true`, `false`	No
arp_table_entries	List	`[arp_table_entries]`	No
auto_negotiation	Boolean	`true`, `false`	No
description	String	max: `255`	No
duplex	Choice	`AUTO`, `FULL`, `HALF`	No	`AUTO`
enable_anti_spoofing	Boolean	`true`, `false`	No
enable_sgt_propagate	Boolean	`true`, `false`	No
enabled	Boolean	`true`, `false`	No	`true`
fec_mode	Choice	`AUTO`, `CL108RS`, `CL74FC`, `CL91RS`, `DISABLE`	No
flow_control_send	Boolean	`true`, `false`	No	`false`
ip_based_monitoring	Boolean	`true`, `false`	No
ip_based_monitoring_next_hop	IP		No
ip_based_monitoring_type	Choice	`AUTO`, `PEER_IPV4`, `PEER_IPV6`, `AUTO4`, `AUTO6`	No
ipv4_dhcp_obtain_route	Boolean	`true`, `false`	No
ipv4_dhcp_route_metric	Integer	min: `1`, max: `255`	No
ipv4_pppoe_authentication	Choice	`PAP`, `CHAP`, `MSCHAP`	No
ipv4_pppoe_password	String		No
ipv4_pppoe_route_metric	Integer	min: `1`, max: `255`	No
ipv4_pppoe_route_settings	Boolean	`true`, `false`	No
ipv4_pppoe_store_credentials_in_flash	Boolean	`true`, `false`	No
ipv4_pppoe_user	String		No
ipv4_pppoe_vpdn_group_name	String		No
ipv4_static_address	IP		No
ipv4_static_netmask	Integer	min: `1`, max: `31`	No
ipv6_addresses	List	`[ipv6_addresses]`	No
ipv6_dad_attempts	Integer	min: `0`, max: `600`	No
ipv6_default_route_by_dhcp	Boolean	`true`, `false`	No
ipv6_dhcp	Boolean	`true`, `false`	No
ipv6_dhcp_client_pd_hint_prefixes	String		No
ipv6_dhcp_client_pd_prefix_name	String		No
ipv6_dhcp_pool_id	String		No
ipv6_enable	Boolean	`true`, `false`	No
ipv6_enable_auto_config	Boolean	`true`, `false`	No
ipv6_enable_dad	Boolean	`true`, `false`	No
ipv6_enable_dhcp_address_config	Boolean	`true`, `false`	No
ipv6_enable_dhcp_nonaddress_config	Boolean	`true`, `false`	No
ipv6_enable_ra	Boolean	`true`, `false`	No
ipv6_enforce_eui	Boolean	`true`, `false`	No
ipv6_link_local_address	String		No
ipv6_ns_interval	Integer	min: `1000`, max: `3600000`	No
ipv6_prefixes	List	`[ipv6_prefixes]`	No
ipv6_ra_interval	Integer	min: `3`, max: `1800`	No
ipv6_ra_life_time	Integer	min: `0`, max: `9000`	No
ipv6_reachable_time	Integer	min: `1000`, max: `3600000`	No
lldp_receive	Boolean	`true`, `false`	No
lldp_transmit	Boolean	`true`, `false`	No
logical_name	String	Regex: `^[a-zA-Z0-9_.+-]{1,64}$`	No
management_access	Boolean	`true`, `false`	No
management_access_network_objects	List	`[management_access_network_objects]`	No
management_only	Boolean	`true`, `false`	No
mtu	Integer	min: `64`, max: `9000`	No
nve_only	Boolean	`true`, `false`	No
override_default_fragment_setting_chain	Integer	min: `1`, max: `8200`	No
override_default_fragment_setting_size	Integer	min: `1`, max: `30000`	No
override_default_fragment_setting_timeout	Integer	min: `1`, max: `30`	No
priority	Integer	min: `0`, max: `65535`	No
security_zone	String		No
speed	Choice	`AUTO`, `TEN`, `HUNDRED`, `THOUSAND`, `TEN_THOUSAND`, `TWENTY_FIVE_THOUSAND`, `FORTY_THOUSAND`, `HUNDRED_THOUSAND`, `TWO_HUNDRED_THOUSAND`, `DETECT_SFP`	No	`AUTO`
standby_mac_address	String		No

etherchannel_interfaces (fmc.domains.devices.devices.vrfs)

Name	Type	Constraint	Mandatory	Default Value
name	String	max: `255`	Yes
mode	Choice	`INLINE`, `PASSIVE`, `TAP`, `ERSPAN`, `NONE`, `SWITCHPORT`	No	`NONE`
active_mac_address	String	max: `17`	No
allow_full_fragment_reassembly	Boolean	`true`, `false`	No
arp_table_entries	List	`[arp_table_entries]`	No
auto_negotiation	Boolean	`true`, `false`	No
description	String	max: `255`	No
duplex	Choice	`AUTO`, `FULL`, `HALF`	No
enable_anti_spoofing	Boolean	`true`, `false`	No
enable_sgt_propagate	Boolean	`true`, `false`	No
enabled	Boolean	`true`, `false`	No
fec_mode	Choice	`AUTO`, `CL108RS`, `CL74FC`, `CL91RS`, `DISABLE`	No
flow_control_send	Boolean	`true`, `false`	No
ip_based_monitoring	Boolean	`true`, `false`	No
ip_based_monitoring_next_hop	IP		No
ip_based_monitoring_type	Choice	`AUTO`, `PEER_IPV4`, `PEER_IPV6`, `AUTO4`, `AUTO6`	No
ipv4_dhcp_obtain_route	Boolean	`true`, `false`	No
ipv4_dhcp_route_metric	Integer	min: `1`, max: `255`	No
ipv4_pppoe_authentication	Choice	`PAP`, `CHAP`, `MSCHAP`	No
ipv4_pppoe_password	String		No
ipv4_pppoe_route_metric	Integer	min: `1`, max: `255`	No
ipv4_pppoe_route_settings	Boolean	`true`, `false`	No
ipv4_pppoe_store_credentials_in_flash	Boolean	`true`, `false`	No
ipv4_pppoe_user	String		No
ipv4_pppoe_vpdn_group_name	String		No
ipv4_static_address	IP		No
ipv4_static_netmask	Integer	min: `1`, max: `31`	No
ipv6_addresses	List	`[ipv6_addresses]`	No
ipv6_dad_attempts	Integer	min: `0`, max: `600`	No
ipv6_default_route_by_dhcp	Boolean	`true`, `false`	No
ipv6_dhcp	Boolean	`true`, `false`	No
ipv6_dhcp_client_pd_hint_prefixes	String		No
ipv6_dhcp_client_pd_prefix_name	String		No
ipv6_dhcp_pool_id	String		No
ipv6_enable	Boolean	`true`, `false`	No
ipv6_enable_auto_config	Boolean	`true`, `false`	No
ipv6_enable_dad	Boolean	`true`, `false`	No
ipv6_enable_dhcp_address_config	Boolean	`true`, `false`	No
ipv6_enable_dhcp_nonaddress_config	Boolean	`true`, `false`	No
ipv6_enable_ra	Boolean	`true`, `false`	No
ipv6_enforce_eui	Boolean	`true`, `false`	No
ipv6_link_local_address	String		No
ipv6_ns_interval	Integer	min: `1000`, max: `3600000`	No
ipv6_prefixes	List	`[ipv6_prefixes]`	No
ipv6_ra_interval	Integer	min: `3`, max: `1800`	No
ipv6_ra_life_time	Integer	min: `0`, max: `9000`	No
ipv6_reachable_time	Integer	min: `1000`, max: `3600000`	No
lldp_receive	Boolean	`true`, `false`	No
lldp_transmit	Boolean	`true`, `false`	No
logical_name	String	Regex: `^[a-zA-Z0-9_.+-]{1,64}$`	No
management_access	Boolean	`true`, `false`	No
management_access_network_objects	List	`[management_access_network_objects]`	No
management_only	Boolean	`true`, `false`	No
mtu	Integer	min: `64`, max: `9000`	No
nve_only	Boolean	`true`, `false`	No
override_default_fragment_setting_chain	Integer	min: `1`, max: `8200`	No
override_default_fragment_setting_size	Integer	min: `1`, max: `30000`	No
override_default_fragment_setting_timeout	Integer	min: `1`, max: `30`	No
priority	Integer	min: `0`, max: `65535`	No
security_zone	String		No
selected_interfaces	List	String	No
speed	Choice	`AUTO`, `TEN`, `HUNDRED`, `THOUSAND`, `TEN_THOUSAND`, `TWENTY_FIVE_THOUSAND`, `FORTY_THOUSAND`, `HUNDRED_THOUSAND`, `TWO_HUNDRED_THOUSAND`, `DETECT_SFP`	No
standby_mac_address	String		No

sub_interfaces (fmc.domains.devices.devices.vrfs)

Name	Type	Constraint	Mandatory	Default Value
name	String	max: `255`	Yes
mode	Choice	`INLINE`, `PASSIVE`, `TAP`, `ERSPAN`, `NONE`, `SWITCHPORT`	No	`NONE`
active_mac_address	String	max: `17`	No
allow_full_fragment_reassembly	Boolean	`true`, `false`	No
arp_table_entries	List	`[arp_table_entries]`	No
description	String	max: `255`	No
enable_anti_spoofing	Boolean	`true`, `false`	No
enable_sgt_propagate	Boolean	`true`, `false`	No
enabled	Boolean	`true`, `false`	No
ip_based_monitoring	Boolean	`true`, `false`	No
ip_based_monitoring_next_hop	IP		No
ip_based_monitoring_type	Choice	`AUTO`, `PEER_IPV4`, `PEER_IPV6`, `AUTO4`, `AUTO6`	No
ipv4_dhcp_obtain_route	Boolean	`true`, `false`	No
ipv4_dhcp_route_metric	Integer	min: `1`, max: `255`	No
ipv4_pppoe_authentication	Choice	`PAP`, `CHAP`, `MSCHAP`	No
ipv4_pppoe_password	String		No
ipv4_pppoe_route_metric	Integer	min: `1`, max: `255`	No
ipv4_pppoe_route_settings	Boolean	`true`, `false`	No
ipv4_pppoe_store_credentials_in_flash	Boolean	`true`, `false`	No
ipv4_pppoe_user	String		No
ipv4_pppoe_vpdn_group_name	String		No
ipv4_static_address	IP		No
ipv4_static_netmask	Integer	min: `1`, max: `31`	No
ipv6_addresses	List	`[ipv6_addresses]`	No
ipv6_dad_attempts	Integer	min: `0`, max: `600`	No
ipv6_default_route_by_dhcp	Boolean	`true`, `false`	No
ipv6_dhcp	Boolean	`true`, `false`	No
ipv6_dhcp_client_pd_hint_prefixes	String		No
ipv6_dhcp_client_pd_prefix_name	String		No
ipv6_dhcp_pool_id	String		No
ipv6_enable	Boolean	`true`, `false`	No
ipv6_enable_auto_config	Boolean	`true`, `false`	No
ipv6_enable_dad	Boolean	`true`, `false`	No
ipv6_enable_dhcp_address_config	Boolean	`true`, `false`	No
ipv6_enable_dhcp_nonaddress_config	Boolean	`true`, `false`	No
ipv6_enable_ra	Boolean	`true`, `false`	No
ipv6_enforce_eui	Boolean	`true`, `false`	No
ipv6_link_local_address	String		No
ipv6_ns_interval	Integer	min: `1000`, max: `3600000`	No
ipv6_prefixes	List	`[ipv6_prefixes]`	No
ipv6_ra_interval	Integer	min: `3`, max: `1800`	No
ipv6_ra_life_time	Integer	min: `0`, max: `9000`	No
ipv6_reachable_time	Integer	min: `1000`, max: `3600000`	No
logical_name	String	Regex: `^[a-zA-Z0-9_.+-]{1,64}$`	No
management_only	Boolean	`true`, `false`	No
mtu	Integer	min: `64`, max: `9000`	No
override_default_fragment_setting_chain	Integer	min: `1`, max: `8200`	No
override_default_fragment_setting_size	Integer	min: `1`, max: `30000`	No
override_default_fragment_setting_timeout	Integer	min: `1`, max: `30`	No
priority	Integer	min: `0`, max: `65535`	No
security_zone	String		No
standby_mac_address	String		No
vlan	Integer	min: `1`, max: `4094`	Yes

ipv4_static_routes (fmc.domains.devices.devices.vrfs)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.+-]{1,64}$`	Yes
gateway	Class	`[gateway]`	Yes
interface_logical_name	String		Yes
metric	Integer	min: `1`, max: `254`	No
selected_networks	List	String	Yes
tunneled	Boolean	`true`, `false`	No

ipv6_static_routes (fmc.domains.devices.devices.vrfs)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.+-]{1,64}$`	Yes
gateway	Class	`[gateway]`	Yes
interface_logical_name	String		Yes
metric	Integer	min: `1`, max: `254`	Yes
selected_networks	List	String	Yes
tunneled	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

arp_table_entries (fmc.domains.devices.devices.vrfs.physical_interfaces)

Name	Type	Constraint	Mandatory
enable_alias	Boolean	`true`, `false`	Yes
ip_address	IP		Yes
mac_address	String	max: `17`	Yes

ipv6_addresses (fmc.domains.devices.devices.vrfs.physical_interfaces)

Name	Type	Constraint	Mandatory
address	String		Yes
enforce_eui	Boolean	`true`, `false`	No
prefix	String		Yes

ipv6_prefixes (fmc.domains.devices.devices.vrfs.physical_interfaces)

Name	Type	Constraint	Mandatory
address	String		Yes
enforce_eui	Boolean	`true`, `false`	Yes
default	String		Yes

management_access_network_objects (fmc.domains.devices.devices.vrfs.physical_interfaces)

Name	Type	Constraint	Mandatory	Default Value
id	String		Yes
type	Choice	`Host`, `Network`, `Range`, `NetworkGroup`	No

gateway (fmc.domains.devices.devices.vrfs.ipv4_static_routes)

Name	Type	Constraint	Mandatory	Default Value
object	String		No
literal	IP		No

gateway (fmc.domains.devices.devices.vrfs.ipv6_static_routes)

Name	Type	Constraint	Mandatory	Default Value
object	String		No
literal	String		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
      policies:
        access_policies:
          - name: MyAccessPolicyName1
            default_action: BLOCK
      devices:
        devices:
          - name: MyDeviceName1
            host: 10.62.158.201
            registration_key: cisco123
            access_policy: MyAccessPolicyName1
            deploy: true
            licenses:
            - ESSENTIALS
            performance_tier: FTDv5

VRF:

fmc:
  domains:
    - name: Global
      devices:
        devices:
          - name: MyDeviceName1
            vrfs:
              - name: Cust-A