aci_bd – Manage Bridge Domains (BD) objects (fv:BD)

From Get docs
Ansible/docs/2.8/modules/aci bd module


aci_bd – Manage Bridge Domains (BD) objects (fv:BD)

New in version 2.4.


Synopsis

  • Manages Bridge Domains (BD) on Cisco ACI fabrics.

Parameters

Parameter Choices/Defaults Comments

arp_flooding

boolean

  • no
  • yes

Determines if the Bridge Domain should flood ARP traffic.

The APIC defaults to no when unset during creation.

bd

string

The name of the Bridge Domain.


aliases: bd_name, name

bd_type

string

  • ethernet
  • fc

The type of traffic on the Bridge Domain.

The APIC defaults to ethernet when unset during creation.

certificate_name

string

The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.

If a private_key filename was provided, this defaults to the private_key basename, without extension.

If PEM-formatted content was provided for private_key, this defaults to the username value.


aliases: cert_name

description

string

Description for the Bridge Domain.

enable_multicast

boolean

  • no
  • yes

Determines if PIM is enabled.

The APIC defaults to no when unset during creation.

enable_routing

boolean

  • no
  • yes

Determines if IP forwarding should be allowed.

The APIC defaults to yes when unset during creation.

endpoint_clear

boolean

  • no
  • yes

Clears all End Points in all Leaves when yes.

The value is not reset to disabled once End Points have been cleared; that requires a second task.

The APIC defaults to no when unset during creation.

endpoint_move_detect

string

  • default
  • garp

Determines if GARP should be enabled to detect when End Points move.

The APIC defaults to garp when unset during creation.

endpoint_retention_action

string

  • inherit
  • resolve

Determines if the Bridge Domain should inherit or resolve the End Point Retention Policy.

The APIC defaults to resolve when unset during creation.

endpoint_retention_policy

string

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

host

string / required

IP Address or hostname of APIC resolvable by Ansible control host.


aliases: hostname

igmp_snoop_policy

string

The name of the IGMP Snooping Policy the Bridge Domain should use when overriding the default IGMP Snooping Policy.

ip_learning

boolean

  • no
  • yes

Determines if the Bridge Domain should learn End Point IPs.

The APIC defaults to yes when unset during creation.

ipv6_nd_policy

string

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

l2_unknown_unicast

string

  • proxy
  • flood

Determines what forwarding method to use for unknown l2 destinations.

The APIC defaults to proxy when unset during creation.

l3_unknown_multicast

string

  • flood
  • opt-flood

Determines the forwarding method to use for unknown multicast destinations.

The APIC defaults to flood when unset during creation.

limit_ip_learn

boolean

  • no
  • yes

Determines if the BD should limit IP learning to only subnets owned by the Bridge Domain.

The APIC defaults to yes when unset during creation.

mac_address

string

added in 2.5

The MAC Address to assign to the bd instead of using the default.

The APIC defaults to 00:22:BD:F8:19:FF when unset during creation.


aliases: mac

multi_dest

string

  • bd-flood
  • drop
  • encap-flood

Determines the forwarding method for L2 multicast, broadcast, and link layer traffic.

The APIC defaults to bd-flood when unset during creation.

output_level

string

  • debug
  • info
  • normal

Influence the output of this ACI module.

normal means the standard output, incl. current dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

password

string / required

The password to use for authentication.

This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.

port

integer

Port number to be used for REST connection.

The default value depends on parameter use_ssl.

private_key

string / required

Either a PEM-formatted private key file or the private key content used for signature-based authentication.

This value also influences the default certificate_name that is used.

This option is mutual exclusive with password. If password is provided too, it will be ignored.


aliases: cert_key

state

string

  • absent
  • present

  • query

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

tenant

string

The name of the Tenant.


aliases: tenant_name

timeout

integer

Default:

30

The socket level timeout in seconds.

use_proxy

boolean

  • no
  • yes

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

use_ssl

boolean

  • no
  • yes

If no, an HTTP connection will be used instead of the default HTTPS connection.

username

string

Default:

"admin"

The username to use for authentication.


aliases: user

validate_certs

boolean

  • no
  • yes

If no, SSL certificates will not be validated.

This should only set to no when used on personally controlled sites using self-signed certificates.

vrf

string

The name of the VRF.


aliases: vrf_name



Notes

Note

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


See Also

See also

aci_tenant – Manage tenants (fv:Tenant)
The official documentation on the aci_tenant module.
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
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: no
    tenant: prod
    bd: web_servers
    mac_address: 00:22:BD:F8:19:FE
    vrf: prod_vrf
    state: present
  delegate_to: localhost

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

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

- name: Query All Bridge Domains
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: yes
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: yes
    tenant: prod
    bd: web_servers
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a Bridge Domain
  aci_bd:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: yes
    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 Returned Description

current

list

success

The existing configuration from the APIC after the module has finished


Sample:

[{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}]

error

dictionary

failure

The error information as returned from the APIC


Sample:

{'code': '122', 'text': 'unknown managed object class foo'}

filter_string

string

failure or debug

The filter string used for the request


Sample:

?rsp-prop-include=config-only

method

string

failure or debug

The HTTP method used for the request to the APIC


Sample:

POST

previous

list

info

The original configuration from the APIC before the module has started


Sample:

[{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}]

proposed

dictionary

info

The assembled configuration from the user-provided parameters


Sample:

{'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}

raw

string

parse error

The raw output returned by the APIC REST API (xml or json)


Sample:


response

string

failure or debug

The HTTP response from the APIC


Sample:

OK (30 bytes)

sent

list

info

The actual/minimal configuration pushed to the APIC


Sample:

{'fvTenant': {'attributes': {'descr': 'Production environment'}}}

status

integer

failure or debug

The HTTP status from the APIC


Sample:

200

url

string

failure or debug

The HTTP url used for the request to the APIC


Sample:




Status

Authors

  • Jacob McGill (@jmcgill298)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_bd_module.html