You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

aci_bd - Manage Bridge Domains (BD) on Cisco ACI Fabrics (fv:BD)¶

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis ¶

Manages Bridge Domains (BD) on Cisco ACI Fabrics.
More information from the internal APIC class fv:BD at https://developer.cisco.com/media/mim-ref/MO-fvBD.html.

Requirements (on host that executes module)¶

ACI Fabric 1.0(3f)+

Options ¶

parameter	required	default	choices	comments
arp_flooding	no		False True	Determines if the Bridge Domain should flood ARP traffic. The APIC defaults new Bridge Domains to `no`.
bd	no			The name of the Bridge Domain. aliases: bd_name, name
bd_type	no	ethernet	ethernet fc	The type of traffic on the Bridge Domain. The APIC defaults new Bridge Domains to `ethernet`.
description	no			Description for the Bridge Domain.
enable_multicast	no		False True	Determines if PIM is enabled The APIC defaults new Bridge Domains to `no`.
enable_routing	no	True	False True	Determines if IP forwarding should be allowed. The APIC defaults new Bridge Domains to `yes`.
endpoint_clear	no		False True	Clears all End Points in all Leaves when `yes`. The APIC defaults new Bridge Domains to `no`. The value is not reset to disabled once End Points have been cleared; that requires a second task.
endpoint_move_detect	no	garp	default garp	Determines if GARP should be enabled to detect when End Points move. The APIC defaults new Bridge Domains to `garp`.
endpoint_retention_action	no	resolve	inherit resolve	Determines if the Bridge Domain should inherit or resolve the End Point Retention Policy. The APIC defaults new Bridge Domain to End Point Retention Policies to `resolve`.
endpoint_retention_policy	no			The name of the End Point Retention Policy the Bridge Domain should use when overriding the default End Point Retention Policy.
igmp_snoop_policy	no			The name of the IGMP Snooping Policy the Bridge Domain should use when overriding the default IGMP Snooping Policy.
ip_learning	no		False True	Determines if the Bridge Domain should learn End Point IPs. The APIC defaults new Bridge Domains to `yes`.
ipv6_nd_policy	no			The name of the IPv6 Neighbor Discovery Policy the Bridge Domain should use when overridding the default IPV6 ND Policy.
l2_unknown_unicast	no	proxy	proxy flood	Determines what forwarding method to use for unknown l2 destinations. The APIC defaults new Bridge domains to `proxy`.
l3_unknown_multicast	no	flood	flood opt-flood	Determines the forwarding method to use for unknown multicast destinations. The APCI defaults new Bridge Domains to `flood`.
limit_ip_learn	no	True	False True	Determines if the BD should limit IP learning to only subnets owned by the Bridge Domain. The APIC defaults new Bridge Domains to `yes`.
multi_dest	no	bd-flood	bd-flood drop encap-flood	Determines the forwarding method for L2 multicast, broadcast, and link layer traffic. The APIC defaults new Bridge Domains to `bd-flood`.
state	no	present	absent present query	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
tenant	no			The name of the Tenant. aliases: tenant_name
vrf	no			The name of the VRF. aliases: vrf_name

Examples ¶

- name: Add Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    state: present
    tenant: prod
    bd: web_servers
    vrf: prod_vrf

- name: Add an FC Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    state: present
    tenant: prod
    bd: storage
    bd_type: fc
    vrf: fc_vrf
    enable_routing: no

- name: Modify a Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    state: present
    tenant: prod
    bd: web_servers
    arp_flooding: yes
    l2_unknown_unicast: flood

- name: Query All Bridge Domains
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    state: query

- name: Query a Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    state: query
    tenant: prod
    bd: web_servers

- name: Delete a Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    state: absent
    tenant: prod
    bd: web_servers

Notes ¶

Note

The tenant used must exist before using this module in your playbook. The aci_tenant module can be used for this.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.