Bridge Domain

Version:

Location in GUI: Tenants » XXX » Networking » Bridge Domains

In Cisco ACI, a Bridge Domain (BD) is a logical construct that defines a layer-2 forwarding domain. It is the equivalent of a VLAN or a broadcast domain in traditional networking. A BD is created as a component of a tenant and must be associated with one VRF instance.

Diagram

Classes

tenants (apic)

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

bridge_domains (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
arp_flooding	Boolean	`true`, `false`	No	`true`
advertise_host_routes	Boolean	`true`, `false`	No	`false`
ip_dataplane_learning	Boolean	`true`, `false`	No	`true`
clear_remote_mac_entries	Boolean	`true`, `false`	No	`false`
limit_ip_learn_to_subnets	Boolean	`true`, `false`	No	`true`
mac	MAC		No	`00:22:BD:F8:19:FF`
virtual_mac	Any	MAC or Choice[`not-applicable`]	No	`not-applicable`
ep_move_detection	Boolean	`true`, `false`	No	`false`
l3_multicast	Boolean	`true`, `false`	No	`false`
multicast_arp_drop	Boolean	`true`, `false`	No	`false`
pim_source_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
pim_destination_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
multi_destination_flooding	Choice	`bd-flood`, `encap-flood`, `drop`	No	`bd-flood`
unicast_routing	Boolean	`true`, `false`	No	`true`
unknown_unicast	Choice	`flood`, `proxy`	No	`flood`
unknown_ipv4_multicast	Choice	`flood`, `opt-flood`	No	`flood`
unknown_ipv6_multicast	Choice	`flood`, `opt-flood`	No	`flood`
vrf	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
subnets	List	`[subnets]`	No
l3outs	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
dhcp_labels	List	`[dhcp_labels]`	No
igmp_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
igmp_snooping_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
nd_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_retention_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
netflow_monitor_policies	List	`[netflow_monitor_policies]`	No

subnets (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
ip	IP		Yes
primary_ip	Boolean	`true`, `false`	No	`false`
public	Boolean	`true`, `false`	No	`false`
shared	Boolean	`true`, `false`	No	`false`
virtual	Boolean	`true`, `false`	No	`false`
igmp_querier	Boolean	`true`, `false`	No	`false`
nd_ra_prefix	Boolean	`true`, `false`	No	`true`
no_default_gateway	Boolean	`true`, `false`	No	`false`
nd_ra_prefix_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip_dataplane_learning	Boolean	`true`, `false`	No

dhcp_labels (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
dhcp_relay_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
dhcp_option_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
scope	Choice	`infra`, `tenant`	No	`tenant`

netflow_monitor_policies (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip_filter_type	Choice	`ipv4`, `ipv6`, `ce`, `unspecified`	No	`ipv4`

Examples

Example-1: This is a single example of a layer-3 bridge-domain where the bridge-domain BD1 is configured under tenant ABC and associated with vrf VRF1. As this is a layer-3 bridge-domain is it configured with IP subnet 1.1.1.1/24. The rest of the bridge-domain settings uses default values.

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          vrf: VRF1
          subnets:
            - ip: 1.1.1.1/24

Example-2: This is a single example of a layer-2 bridge-domain where the bridge-domain BD1 is configured under tenant ABC and associated with vrf VRF1. Unlike a layer-3 bridge-domain, no IP subnet is configured. Instead,, L2 unknown unicast is set to flooding, unicast routing is disabled, and ARP flooding is enabled. The rest of the settings use default values.

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          vrf: VRF1
          unknown_unicast: flood
          arp_flooding: true
          unicast_routing: false

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

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          alias: ABC_BD1
          mac: 00:22:BD:F8:19:FE
          virtual_mac: 00:23:BD:F8:19:12
          ep_move_detection: true
          arp_flooding: false
          ip_dataplane_learning: false
          limit_ip_learn_to_subnets: false
          multi_destination_flooding: encap-flood
          unknown_unicast: proxy
          unknown_ipv4_multicast: flood
          unknown_ipv6_multicast: flood
          unicast_routing: true
          clear_remote_mac_entries: true
          advertise_host_routes: true
          l3_multicast: false
          multicast_arp_drop: false
          vrf: VRF1
          nd_interface_policy: "ND_INTF_POL1"
          endpoint_retention_policy: ERP1
          netflow_monitor_policies:
            - name: MONITOR1
            - ip_filter_type: ipv4
          subnets:
            - ip: 1.1.1.1/24
              description: My Desc
              primary_ip: true
              public: true
              shared: true
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
            - ip: fd00:0:abcd:1::1/64
              description: My IPv6 Desc
              primary_ip: true
              public: true
              shared: false
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
              nd_ra_prefix_policy: ND-RA-PREFIX1
              ip_dataplane_learning: false
          l3outs:
            - L3OUT1
          dhcp_labels:
            - dhcp_relay_policy: DHCP-RELAY1
              dhcp_option_policy: DHCP-OPTION1

Location in GUI: Tenants » XXX » Networking » Bridge Domains

Diagram

Classes

tenants (apic)

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

bridge_domains (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
arp_flooding	Boolean	`true`, `false`	No	`true`
advertise_host_routes	Boolean	`true`, `false`	No	`false`
ip_dataplane_learning	Boolean	`true`, `false`	No	`true`
clear_remote_mac_entries	Boolean	`true`, `false`	No	`false`
limit_ip_learn_to_subnets	Boolean	`true`, `false`	No	`true`
mac	MAC		No	`00:22:BD:F8:19:FF`
virtual_mac	MAC		No
ep_move_detection	Boolean	`true`, `false`	No	`false`
l3_multicast	Boolean	`true`, `false`	No	`false`
multicast_arp_drop	Boolean	`true`, `false`	No	`false`
pim_source_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
pim_destination_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
multi_destination_flooding	Choice	`bd-flood`, `encap-flood`, `drop`	No	`bd-flood`
unicast_routing	Boolean	`true`, `false`	No	`true`
unknown_unicast	Choice	`flood`, `proxy`	No	`flood`
unknown_ipv4_multicast	Choice	`flood`, `opt-flood`	No	`flood`
unknown_ipv6_multicast	Choice	`flood`, `opt-flood`	No	`flood`
vrf	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
subnets	List	`[subnets]`	No
l3outs	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
dhcp_labels	List	`[dhcp_labels]`	No
igmp_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
igmp_snooping_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
nd_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_retention_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

subnets (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
ip	IP		Yes
primary_ip	Boolean	`true`, `false`	No	`false`
public	Boolean	`true`, `false`	No	`false`
shared	Boolean	`true`, `false`	No	`false`
virtual	Boolean	`true`, `false`	No	`false`
igmp_querier	Boolean	`true`, `false`	No	`false`
nd_ra_prefix	Boolean	`true`, `false`	No	`true`
no_default_gateway	Boolean	`true`, `false`	No	`false`
nd_ra_prefix_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip_dataplane_learning	Boolean	`true`, `false`	No

dhcp_labels (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
dhcp_relay_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
dhcp_option_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
scope	Choice	`infra`, `tenant`	No	`tenant`

Examples

Simple example:

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          vrf: VRF1
          subnets:
            - ip: 1.1.1.1/24

Full example:

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          alias: ABC_BD1
          mac: 00:22:BD:F8:19:FE
          virtual_mac: 00:23:BD:F8:19:12
          ep_move_detection: true
          arp_flooding: false
          ip_dataplane_learning: false
          limit_ip_learn_to_subnets: false
          multi_destination_flooding: encap-flood
          unknown_unicast: proxy
          unknown_ipv4_multicast: flood
          unknown_ipv6_multicast: flood
          unicast_routing: true
          clear_remote_mac_entries: true
          advertise_host_routes: true
          l3_multicast: false
          multicast_arp_drop: false
          vrf: VRF1
          nd_interface_policy: "ND_INTF_POL1"
          endpoint_retention_policy: ERP1
          subnets:
            - ip: 1.1.1.1/24
              description: My Desc
              primary_ip: true
              public: true
              shared: true
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
            - ip: fd00:0:abcd:1::1/64
              description: My IPv6 Desc
              primary_ip: true
              public: true
              shared: false
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
              nd_ra_prefix_policy: ND-RA-PREFIX1
              ip_dataplane_learning: false
          l3outs:
            - L3OUT1
          dhcp_labels:
            - dhcp_relay_policy: DHCP-RELAY1
              dhcp_option_policy: DHCP-OPTION1

Location in GUI: Tenants » XXX » Networking » Bridge Domains

Diagram

Classes

tenants (apic)

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

bridge_domains (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
arp_flooding	Boolean	`true`, `false`	No	`true`
advertise_host_routes	Boolean	`true`, `false`	No	`false`
ip_dataplane_learning	Boolean	`true`, `false`	No	`true`
clear_remote_mac_entries	Boolean	`true`, `false`	No	`false`
limit_ip_learn_to_subnets	Boolean	`true`, `false`	No	`true`
mac	MAC		No	`00:22:BD:F8:19:FF`
virtual_mac	MAC		No
ep_move_detection	Boolean	`true`, `false`	No	`false`
l3_multicast	Boolean	`true`, `false`	No	`false`
multicast_arp_drop	Boolean	`true`, `false`	No	`false`
pim_source_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
pim_destination_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
multi_destination_flooding	Choice	`bd-flood`, `encap-flood`, `drop`	No	`bd-flood`
unicast_routing	Boolean	`true`, `false`	No	`true`
unknown_unicast	Choice	`flood`, `proxy`	No	`flood`
unknown_ipv4_multicast	Choice	`flood`, `opt-flood`	No	`flood`
unknown_ipv6_multicast	Choice	`flood`, `opt-flood`	No	`flood`
vrf	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
subnets	List	`[subnets]`	No
l3outs	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
dhcp_labels	List	`[dhcp_labels]`	No
igmp_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
igmp_snooping_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
nd_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_retention_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

subnets (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
ip	IP		Yes
primary_ip	Boolean	`true`, `false`	No	`false`
public	Boolean	`true`, `false`	No	`false`
shared	Boolean	`true`, `false`	No	`false`
virtual	Boolean	`true`, `false`	No	`false`
igmp_querier	Boolean	`true`, `false`	No	`false`
nd_ra_prefix	Boolean	`true`, `false`	No	`true`
no_default_gateway	Boolean	`true`, `false`	No	`false`
nd_ra_prefix_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip_dataplane_learning	Boolean	`true`, `false`	No

dhcp_labels (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
dhcp_relay_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
dhcp_option_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
scope	Choice	`infra`, `tenant`	No	`tenant`

Examples

Simple example:

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          vrf: VRF1
          subnets:
            - ip: 1.1.1.1/24

Full example:

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          alias: ABC_BD1
          mac: 00:22:BD:F8:19:FE
          virtual_mac: 00:23:BD:F8:19:12
          ep_move_detection: true
          arp_flooding: false
          ip_dataplane_learning: false
          limit_ip_learn_to_subnets: false
          multi_destination_flooding: encap-flood
          unknown_unicast: proxy
          unknown_ipv4_multicast: flood
          unknown_ipv6_multicast: flood
          unicast_routing: true
          clear_remote_mac_entries: true
          advertise_host_routes: true
          l3_multicast: false
          multicast_arp_drop: false
          vrf: VRF1
          nd_interface_policy: "ND_INTF_POL1"
          subnets:
            - ip: 1.1.1.1/24
              description: My Desc
              primary_ip: true
              public: true
              shared: true
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
            - ip: fd00:0:abcd:1::1/64
              description: My IPv6 Desc
              primary_ip: true
              public: true
              shared: false
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
              nd_ra_prefix_policy: ND-RA-PREFIX1
              ip_dataplane_learning: false
          l3outs:
            - L3OUT1
          dhcp_labels:
            - dhcp_relay_policy: DHCP-RELAY1
              dhcp_option_policy: DHCP-OPTION1

Location in GUI: Tenants » XXX » Networking » Bridge Domains

Diagram

Classes

tenants (apic)

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

bridge_domains (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
arp_flooding	Boolean		No	`true`
advertise_host_routes	Boolean		No	`false`
ip_dataplane_learning	Boolean		No	`true`
clear_remote_mac_entries	Boolean		No	`false`
limit_ip_learn_to_subnets	Boolean		No	`true`
mac	MAC		No	`00:22:BD:F8:19:FF`
virtual_mac	MAC		No
ep_move_detection	Boolean		No	`false`
l3_multicast	Boolean		No	`false`
multicast_arp_drop	Boolean	`true`, `false`	No	`false`
pim_source_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
pim_destination_filter	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
multi_destination_flooding	Choice	`bd-flood`, `encap-flood`, `drop`	No	`bd-flood`
unicast_routing	Boolean		No	`true`
unknown_unicast	Choice	`flood`, `proxy`	No	`flood`
unknown_ipv4_multicast	Choice	`flood`, `opt-flood`	No	`flood`
unknown_ipv6_multicast	Choice	`flood`, `opt-flood`	No	`flood`
vrf	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
subnets	List	`[subnets]`	No
l3outs	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
dhcp_labels	List	`[dhcp_labels]`	No
igmp_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
igmp_snooping_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
nd_interface_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

subnets (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
ip	IP		Yes
primary_ip	Boolean		No	`false`
public	Boolean		No	`false`
shared	Boolean		No	`false`
virtual	Boolean		No	`false`
igmp_querier	Boolean		No	`false`
nd_ra_prefix	Boolean		No	`true`
no_default_gateway	Boolean		No	`false`
nd_ra_prefix_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip_dataplane_learning	Boolean	`true`, `false`	No

dhcp_labels (apic.tenants.bridge_domains)

Name	Type	Constraint	Mandatory	Default Value
dhcp_relay_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
dhcp_option_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
scope	Choice	`infra`, `tenant`	No	`tenant`

Examples

Simple example:

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          vrf: VRF1
          subnets:
            - ip: 1.1.1.1/24

Full example:

apic:
  tenants:
    - name: ABC
      bridge_domains:
        - name: BD1
          alias: ABC_BD1
          mac: 00:22:BD:F8:19:FE
          virtual_mac: 00:23:BD:F8:19:12
          ep_move_detection: true
          arp_flooding: false
          ip_dataplane_learning: false
          limit_ip_learn_to_subnets: false
          multi_destination_flooding: encap-flood
          unknown_unicast: proxy
          unknown_ipv4_multicast: flood
          unknown_ipv6_multicast: flood
          unicast_routing: true
          clear_remote_mac_entries: true
          advertise_host_routes: true
          l3_multicast: false
          multicast_arp_drop: false
          vrf: VRF1
          nd_interface_policy: "ND_INTF_POL1"
          subnets:
            - ip: 1.1.1.1/24
              description: My Desc
              primary_ip: true
              public: true
              shared: true
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
            - ip: fd00:0:abcd:1::1/64
              description: My IPv6 Desc
              primary_ip: true
              public: true
              shared: false
              virtual: false
              igmp_querier: true
              nd_ra_prefix: true
              no_default_gateway: false
              nd_ra_prefix_policy: ND-RA-PREFIX1
              ip_dataplane_learning: false
          l3outs:
            - L3OUT1
          dhcp_labels:
            - dhcp_relay_policy: DHCP-RELAY1
              dhcp_option_policy: DHCP-OPTION1