VRF

Location in GUI: Tenants » XXX » Networking » VRFs

Diagram

Classes

tenants (apic)

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

vrfs (apic.tenants)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
ndo_managed	Boolean	`true`, `false`	No	`false`
alias	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
data_plane_learning	Boolean	`true`, `false`	No	`true`
enforcement_direction	Choice	`ingress`, `egress`	No	`ingress`
enforcement_preference	Choice	`enforced`, `unenforced`	No	`enforced`
preferred_group	Boolean	`true`, `false`	No	`false`
endpoint_retention_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
transit_route_tag_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
leaked_internal_prefixes	List	`[leaked_internal_prefixes]`	No
leaked_external_prefixes	List	`[leaked_external_prefixes]`	No
contracts	Class	`[contracts]`	No
bgp	Class	`[bgp]`	No
ospf	Class	`[ospf]`	No
dns_labels	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
pim	Class	`[pim]`	No
route_summarization_policies	List	`[route_summarization_policies]`	No

leaked_internal_prefixes (apic.tenants.vrfs)

Name	Type	Constraint	Mandatory	Default Value
prefix	IP		Yes
public	Boolean	`true`, `false`	No	`false`
destinations	List	`[destinations]`	No

leaked_external_prefixes (apic.tenants.vrfs)

Name	Type	Constraint	Mandatory
prefix	IP		Yes
from_prefix_length	Integer	min: `1`, max: `128`	No
to_prefix_length	Integer	min: `1`, max: `128`	No
destinations	List	`[destinations]`	No

contracts (apic.tenants.vrfs)

Name	Type	Constraint	Mandatory
consumers	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
providers	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
imported_consumers	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No

bgp (apic.tenants.vrfs)

Name	Type	Constraint	Mandatory
timer_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ipv4_address_family_context_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ipv6_address_family_context_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ipv4_import_route_target	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
ipv4_export_route_target	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
ipv6_import_route_target	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
ipv6_export_route_target	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No

ospf (apic.tenants.vrfs)

Name	Type	Constraint	Mandatory
timer_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ipv4_address_family_context_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ipv6_address_family_context_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

pim (apic.tenants.vrfs)

Name	Type	Constraint	Mandatory	Default Value
mtu	Integer	min: `1`, max: `9300`	No	`1500`
fast_convergence	Boolean	`true`, `false`	No	`false`
strict_rfc	Boolean	`true`, `false`	No	`false`
max_multicast_entries	Any	Integer[min: `1`, max: `4294967295`] or Choice[`unlimited`]	No	`unlimited`
reserved_multicast_entries	Any	Integer[min: `0`, max: `4294967295`] or Choice[`undefined`]	No	`undefined`
resource_policy_multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
static_rps	List	`[static_rps]`	No
fabric_rps	List	`[fabric_rps]`	No
bsr_forward_updates	Boolean	`true`, `false`	No	`false`
bsr_listen_updates	Boolean	`true`, `false`	No	`false`
bsr_filter_multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
auto_rp_forward_updates	Boolean	`true`, `false`	No	`false`
auto_rp_listen_updates	Boolean	`true`, `false`	No	`false`
auto_rp_filter_multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
asm_shared_range_multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
asm_sg_expiry_multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
asm_sg_expiry	Any	Integer[min: `180`, max: `604801`] or Choice[`default-timeout`]	No	`default-timeout`
asm_traffic_registry_max_rate	Integer	min: `1`, max: `65535`	No	`65535`
asm_traffic_registry_source_ip	IP		No	`0.0.0.0`
ssm_group_range_multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
igmp_context_ssm_translate_policies	List	`[igmp_context_ssm_translate_policies]`	No
inter_vrf_policies	List	`[inter_vrf_policies]`	No

route_summarization_policies (apic.tenants.vrfs)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
nodes	List	`[nodes]`	No
subnets	List	`[subnets]`	No

destinations (apic.tenants.vrfs.leaked_internal_prefixes)

Name	Type	Constraint	Mandatory
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
vrf	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
public	Boolean	`true`, `false`	No

destinations (apic.tenants.vrfs.leaked_external_prefixes)

Name	Type	Constraint	Mandatory
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
vrf	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes

static_rps (apic.tenants.vrfs.pim)

Name	Type	Constraint	Mandatory	Default Value
ip	IP		Yes
multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

igmp_context_ssm_translate_policies (apic.tenants.vrfs.pim)

Name	Type	Constraint	Mandatory	Default Value
group_prefix	IP		Yes
source_address	IP		Yes

inter_vrf_policies (apic.tenants.vrfs.pim)

Name	Type	Constraint	Mandatory
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
vrf	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
multicast_route_map	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

nodes (apic.tenants.vrfs.route_summarization_policies)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `101`, max: `4000`	Yes
pod	Integer	min: `1`, max: `255`	No	`1`

subnets (apic.tenants.vrfs.route_summarization_policies)

Name	Type	Constraint	Mandatory	Default Value
prefix	IP		Yes
bgp_route_summarization_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

Examples

Example-1: This is a single example of a configuration where only the VRF name is specified. Apart from the VRF name, the rest of the settings use default values.

apic:
  tenants:
    - name: ABC
      vrfs:
        - name: VRF1

Example-2: This is a single example of a configuration where, in addition to the settings in Example-1, vzAny is configured. The rest of the settings use default values.

apic:
  tenants:
    - name: ABC
      vrfs:
        - name: VRF1
          contracts:
            consumers:
              - vzAny_Contract
            providers:
              - vzAny_Contract

Example-3: This is a single example of a configuration where all parameters are explicitly specified.

apic:
  tenants:
    - name: ABC
      vrfs:
        - name: VRF1
          alias: VRF1-ALIAS
          description: My VRF
          data_plane_learning: false
          enforcement_direction: egress
          enforcement_preference: unenforced
          transit_route_tag_policy: TRP1
          endpoint_retention_policy: ERP1
          bgp:
            timer_policy: BGP-TIMER1
            ipv4_import_route_target:
              - route-target:as2-nn2:10:10
              - route-target:as2-nn2:10:11
            ipv4_export_route_target:
              - route-target:as2-nn2:10:12
              - route-target:as2-nn2:10:13
            ipv6_import_route_target:
              - route-target:as2-nn2:10:14
              - route-target:as2-nn2:10:16
            ipv6_export_route_target:
              - route-target:as2-nn2:10:17
              - route-target:as2-nn2:10:18
          dns_labels:
            - DNS1
          contracts:
            consumers:
              - CON1
            providers:
              - CON1
            imported_consumers:
              - IMPORT-CON1
          leaked_internal_prefixes:
            - prefix: 1.1.1.0/24
              public: true
              destinations:
                - tenant: ABC
                  vrf: VRF2
                  public: false
                  description: Leak to VRF2
          leaked_external_prefixes:
            - prefix: 3.3.0.0/16
              from_prefix_length: 24
              to_prefix_length: 32
              destinations:
                - tenant: ABC
                  vrf: VRF2
                  description: Leak to VRF2
          pim:
            mtu: 9000
            fast_convergence: true
            strict_rfc: true
            resource_policy_multicast_route_map: TEST_MRM1
            max_multicast_entries: 10
            reserved_multicast_entries: 10
            static_rps:
              - ip: 1.1.1.1
              - ip: 1.1.1.2
                multicast_route_map: TEST_MRM1
            fabric_rps:
              - ip: 1.1.1.3
              - ip: 1.1.1.4
                multicast_route_map: TEST_MRM1
            auto_rp_forward_updates: true
            auto_rp_filter_multicast_route_map: TEST_MRM1
            bsr_listen_updates: true
            bsr_filter_multicast_route_map: TEST_MRM1
            asm_shared_range_multicast_route_map: TEST_MRM1
            asm_sg_expiry_multicast_route_map: TEST_MRM2
            asm_sg_expiry: 200
            asm_traffic_registry_max_rate: 100
            asm_traffic_registry_source_ip: 1.1.1.1
            ssm_group_range_multicast_route_map: TEST_MRM3
            igmp_context_ssm_translate_policies:
              - group_prefix: "228.0.0.0/8"
                source_address: 3.3.3.3
              - group_prefix: "229.0.0.0/8"
                source_address: 4.4.4.4
            inter_vrf_policies:
              - tenant: DEF
                vrf: DMZ
                multicast_route_map: TEST_MRM4
              - tenant: DEF
                vrf: DEV
          route_summarization_policies:
            - name: RTSUM1
              nodes:
                - id: 101
                - id: 102
              subnets:
                - prefix: 1.1.0.0/16
                  bgp_route_summarization_policy: BGP_ROUTE_SUMMARIZATION1
                - prefix: 192.168.0.0/16