cisco.aci.aci_bd – Manage Bridge Domains (BD) objects (fv:BD)
cisco.aci.aci_bd – Manage Bridge Domains (BD) objects (fv:BD)
Note
This plugin is part of the cisco.aci collection (version 1.1.1).
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 | Choices/Defaults | Comments |
---|---|---|
annotation string |
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable | |
arp_flooding boolean |
|
Determines if the Bridge Domain should flood ARP traffic. The APIC defaults to |
bd string |
The name of the Bridge Domain.
| |
bd_type string |
|
The type of traffic on the Bridge Domain. The APIC defaults to |
certificate_name string |
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 string |
Description for the Bridge Domain. | |
enable_multicast boolean |
|
Determines if PIM is enabled. The APIC defaults to |
enable_routing boolean |
|
Determines if IP forwarding should be allowed. The APIC defaults to |
endpoint_clear boolean |
|
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 |
endpoint_move_detect string |
|
Determines if GARP should be enabled to detect when End Points move. The APIC defaults to |
endpoint_retention_action string |
|
Determines if the Bridge Domain should inherit or resolve the End Point Retention Policy. The APIC defaults to |
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. If the value is not specified in the task, the value of environment variable
| |
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 |
|
Determines if the Bridge Domain should learn End Point IPs. The APIC defaults to |
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 |
|
Determines what forwarding method to use for unknown l2 destinations. The APIC defaults to |
l3_unknown_multicast string |
|
Determines the forwarding method to use for unknown multicast destinations. The APIC defaults to |
limit_ip_learn boolean |
|
Determines if the BD should limit IP learning to only subnets owned by the Bridge Domain. The APIC defaults to |
mac_address string |
The MAC Address to assign to the The APIC defaults to
| |
multi_dest string |
|
Determines the forwarding method for L2 multicast, broadcast, and link layer traffic. The APIC defaults to |
name_alias string |
The alias for the current object. This relates to the nameAlias field in ACI. | |
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable |
output_path string |
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 | |
owner_key string |
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 | |
owner_tag string |
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 | |
password string |
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 | |
port integer |
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 | |
private_key string |
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
| |
state string |
|
Use Use |
tenant string |
The name of the Tenant.
| |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables
|
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
vrf string |
The name of the VRF.
|
Notes
Note
- The
tenant
used 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
- The official documentation on the cisco.aci.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
cisco.aci.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
cisco.aci.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
cisco.aci.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
cisco.aci.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
cisco.aci.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
cisco.aci.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 / elements=string |
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 / elements=string |
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 / elements=string |
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: |
Authors
- Jacob McGill (@jmcgill298)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_bd_module.html