ansible.builtin.aci_bd (v2.4.0.0-1) — module

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

| "added in version" 2.4 of ansible.builtin"

Authors: Swetha Chunduri (@schunduri), Dag Wieers (@dagwieers), Jacob McGill (@jmcgill298)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.4.0.0.post1

Description

Manages Bridge Domains (BD) on Cisco ACI Fabrics.

More information from the internal APIC class I(fv:BD) at U(https://developer.cisco.com/media/mim-ref/MO-fvBD.html).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query All Bridge Domains
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    state: query
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query a Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    state: query
    tenant: prod
    bd: web_servers
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete a Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: true
    state: absent
    tenant: prod
    bd: web_servers

Inputs

    
bd:
    aliases:
    - bd_name
    - name
    description:
    - The name of the Bridge Domain.

vrf:
    aliases:
    - vrf_name
    description:
    - The name of the VRF.

state:
    choices:
    - absent
    - present
    - query
    default: present
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.

tenant:
    aliases:
    - tenant_name
    description:
    - The name of the Tenant.

bd_type:
    choices:
    - ethernet
    - fc
    default: ethernet
    description:
    - The type of traffic on the Bridge Domain.
    - The APIC defaults new Bridge Domains to C(ethernet).

multi_dest:
    choices:
    - bd-flood
    - drop
    - encap-flood
    default: bd-flood
    description:
    - Determines the forwarding method for L2 multicast, broadcast, and link layer traffic.
    - The APIC defaults new Bridge Domains to C(bd-flood).

description:
    description:
    - Description for the Bridge Domain.

ip_learning:
    choices:
    - false
    - true
    description:
    - Determines if the Bridge Domain should learn End Point IPs.
    - The APIC defaults new Bridge Domains to C(yes).

arp_flooding:
    choices:
    - false
    - true
    default: false
    description:
    - Determines if the Bridge Domain should flood ARP traffic.
    - The APIC defaults new Bridge Domains to C(no).

enable_routing:
    choices:
    - false
    - true
    default: true
    description:
    - Determines if IP forwarding should be allowed.
    - The APIC defaults new Bridge Domains to C(yes).

endpoint_clear:
    choices:
    - false
    - true
    default: false
    description:
    - Clears all End Points in all Leaves when C(yes).
    - The APIC defaults new Bridge Domains to C(no).
    - The value is not reset to disabled once End Points have been cleared; that requires
      a second task.

ipv6_nd_policy:
    description:
    - The name of the IPv6 Neighbor Discovery Policy the Bridge Domain should use when
      overridding the default IPV6 ND Policy.

limit_ip_learn:
    choices:
    - false
    - true
    default: true
    description:
    - Determines if the BD should limit IP learning to only subnets owned by the Bridge
      Domain.
    - The APIC defaults new Bridge Domains to C(yes).

enable_multicast:
    choices:
    - false
    - true
    default: false
    description:
    - Determines if PIM is enabled
    - The APIC defaults new Bridge Domains to C(no).

igmp_snoop_policy:
    description:
    - The name of the IGMP Snooping Policy the Bridge Domain should use when overriding
      the default IGMP Snooping Policy.

l2_unknown_unicast:
    choices:
    - proxy
    - flood
    default: proxy
    description:
    - Determines what forwarding method to use for unknown l2 destinations.
    - The APIC defaults new Bridge domains to C(proxy).

endpoint_move_detect:
    choices:
    - default
    - garp
    default: garp
    description:
    - Determines if GARP should be enabled to detect when End Points move.
    - The APIC defaults new Bridge Domains to C(garp).

l3_unknown_multicast:
    choices:
    - flood
    - opt-flood
    default: flood
    description:
    - Determines the forwarding method to use for unknown multicast destinations.
    - The APCI defaults new Bridge Domains to C(flood).

endpoint_retention_action:
    choices:
    - inherit
    - resolve
    default: resolve
    description:
    - 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 C(resolve).

endpoint_retention_policy:
    description:
    - The name of the End Point Retention Policy the Bridge Domain should use when overriding
      the default End Point Retention Policy.