cisco.aci.aci_bd module – Manage Bridge Domains (BD) objects (fv:BD)
Note
This module is part of the cisco.aci collection (version 2.12.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.aci.
To use it in a playbook, specify: cisco.aci.aci_bd.
Synopsis
Manages Bridge Domains (BD) on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
|---|---|
Control whether BUM traffic is allowed between sites. The APIC defaults to Choices:
|
|
Allow L2 Stretch between sites. The APIC defaults to Choices:
|
|
Flag to indicate if ipv6 multicast is enabled. The APIC defaults to Choices:
|
|
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable If the value is not specified in the task and environment variable Default: |
|
Determines if the Bridge Domain should flood ARP traffic. The APIC defaults to Choices:
|
|
The name of the Bridge Domain. |
|
The type of traffic on the Bridge Domain. The APIC defaults to Choices:
|
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for If the value is not specified in the task, the value of environment variable |
|
Description for the Bridge Domain. |
|
Determines if PIM is enabled. The APIC defaults to Choices:
|
|
Rogue exception MAC wildcard support for Bridge Domains. Only available in APIC version 6.0 or later. The APIC defaults to Choices:
|
|
Determines if IP forwarding should be allowed. The APIC defaults to Choices:
|
|
Clears all End Points in all Leaves when The value is not reset to disabled once End Points have been cleared; that requires a second task. The APIC defaults to Choices:
|
|
Determines if GARP should be enabled to detect when End Points move. Choices:
|
|
Determines if the Bridge Domain should inherit or resolve the End Point Retention Policy. The APIC defaults to Choices:
|
|
The name of the End Point Retention Policy the Bridge Domain should use when overriding the default End Point Retention Policy. |
|
The name of the First Hop Security Policy to apply to the Bridge Domain. To delete this attribute, pass an empty string. |
|
IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable |
|
Enables advertising host routes (/32 prefixes) out of the L3OUT(s) that are associated to this BD. The APIC defaults to Choices:
|
|
The name of the IGMP Interface Policy the Bridge Domain should use when overriding the default IGMP Interface Policy. To delete this attribute, pass an empty string. |
|
The name of the IGMP Snooping Policy the Bridge Domain should use when overriding the default IGMP Snooping Policy. |
|
Determines if the Bridge Domain should learn End Point IPs. The APIC defaults to Choices:
|
|
Determines the forwarding method to use for IPv6 unknown multicast destinations. The APIC defaults to Choices:
|
|
The name of the IPv6 Neighbor Discovery Policy the Bridge Domain should use when overridding the default IPV6 ND Policy. |
|
Determines what forwarding method to use for unknown l2 destinations. The APIC defaults to Choices:
|
|
Determines the forwarding method to use for unknown multicast destinations. The APIC defaults to Choices:
|
|
Determines if the BD should limit IP learning to only subnets owned by the Bridge Domain. The APIC defaults to Choices:
|
|
The override of the system generated IPv6 link-local address. |
|
The MAC Address to assign to the The APIC defaults to |
|
The name of the Multicast Listener Discovery (MLD) Snooping Policy the Bridge Domain should use when overriding the default MLD Snooping Policy. To delete this attribute, pass an empty string. |
|
The name of the Monitoring Policy to apply to the Bridge Domain. To delete this attribute, pass an empty string. |
|
Determines the forwarding method for L2 multicast, broadcast, and link layer traffic. The APIC defaults to Choices:
|
|
Enable BD rogue multicast ARP packet drop. Only available in APIC version 6.0 or later. The APIC defaults to Choices:
|
|
The alias for the current object. This relates to the nameAlias field in ACI. |
|
Optimize WAN Bandwidth improves the network application experience at the branch and makes better use of limited network resources. The APIC defaults to Choices:
|
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable |
|
User-defined string for the ownerKey attribute of an ACI object. This attribute represents a key for enabling clients to own their data for entity correlation. If the value is not specified in the task, the value of environment variable |
|
User-defined string for the ownerTag attribute of an ACI object. This attribute represents a tag for enabling clients to add their own data. For example, to indicate who created this object. If the value is not specified in the task, the value of environment variable |
|
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables |
|
The name of the PIM Destination Filter to apply to the Bridge Domain. To delete this attribute, pass an empty string. Only available in APIC version 5.2 or later. |
|
The name of the PIM Source Filter to apply to the Bridge Domain. To delete this attribute, pass an empty string. Only available in APIC version 5.2 or later. |
|
Port number to be used for REST connection. The default value depends on parameter If the value is not specified in the task, the value of environment variable |
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default This option is mutual exclusive with If the value is not specified in the task, the value of environment variable |
|
The Route Profile to associate with the Bridge Domain. |
|
The L3 Out that contains the associated Route Profile. |
|
Use Use Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices:
|
|
The name of the Tenant. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable The default value is 30. |
|
If If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true when the connection is local. Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables The default value is admin. |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
The selected VLAN for bridge domain access port encapsulation. To delete this attribute, pass an empty string. |
|
Virtual MAC address of the BD/SVI. This is used when the BD is extended to multiple sites using L2 Outside. |
|
The name of the VRF. |
Notes
Note
The
tenantused must exist before using this module in your playbook. The cisco.aci.aci_tenant module can be used for this.
See Also
See also
- cisco.aci.aci_tenant
Manage tenants (fv:Tenant).
- APIC Management Information Model reference
More information about the internal APIC class fv:BD.
- Cisco ACI Guide
Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples
- name: Add Bridge Domain
cisco.aci.aci_bd:
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: false
tenant: prod
bd: web_servers
mac_address: 00:22:BD:F8:19:FE
vrf: prod_vrf
host_based_routing: true
allow_intersite_bum_traffic: true
allow_intersite_l2_stretch: true
allow_ipv6_mcast: true
ll_addr: "fe80::1322:33ff:fe44:5566"
vmac: "00:AA:BB:CC:DD:03"
optimize_wan_bandwidth: true
vlan: vlan-101
igmp_policy: web_servers_igmp_pol
monitoring_policy: web_servers_monitoring_pol
igmp_snoop_policy: web_servers_igmp_snoop
mld_snoop_policy: web_servers_mld_snoop
first_hop_security_policy: web_servers_fhs
state: present
delegate_to: localhost
- name: Add an FC Bridge Domain
cisco.aci.aci_bd:
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: false
tenant: prod
bd: storage
bd_type: fc
vrf: fc_vrf
enable_routing: false
state: present
delegate_to: localhost
- name: Modify a Bridge Domain
cisco.aci.aci_bd:
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: true
tenant: prod
bd: web_servers
arp_flooding: true
l2_unknown_unicast: flood
state: present
delegate_to: localhost
- name: Modify a Bridge Domain to remove mld_snoop_policy and first_hop_security_policy
cisco.aci.aci_bd:
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: true
tenant: prod
bd: web_servers
arp_flooding: true
l2_unknown_unicast: flood
mld_snoop_policy: ""
first_hop_security_policy: ""
state: present
delegate_to: localhost
- name: Query All Bridge Domains
cisco.aci.aci_bd:
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: true
state: query
delegate_to: localhost
register: query_result
- name: Query a Bridge Domain
cisco.aci.aci_bd:
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: true
tenant: prod
bd: web_servers
state: query
delegate_to: localhost
register: query_result
- name: Delete a Bridge Domain
cisco.aci.aci_bd:
host: "{{ inventory_hostname }}"
username: "{{ username }}"
password: "{{ password }}"
validate_certs: true
tenant: prod
bd: web_servers
state: absent
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The existing configuration from the APIC after the module has finished Returned: success Sample: |
|
The error information as returned from the APIC Returned: failure Sample: |
|
The filter string used for the request Returned: failure or debug Sample: |
|
The HTTP method used for the request to the APIC Returned: failure or debug Sample: |
|
The original configuration from the APIC before the module has started Returned: info Sample: |
|
The assembled configuration from the user-provided parameters Returned: info Sample: |
|
The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: |
|
The HTTP response from the APIC Returned: failure or debug Sample: |
|
The actual/minimal configuration pushed to the APIC Returned: info Sample: |
|
The HTTP status from the APIC Returned: failure or debug Sample: |
|
The HTTP url used for the request to the APIC Returned: failure or debug Sample: |