aci_bd
Manage Bridge Domains (BD) objects (fv:BD)
Collection: cisco.aci
Full Name: cisco.aci.aci_bd
Synopsis
Manage Bridge Domains (BD) objects (fv:BD)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| allow_intersite_bum_traffic | bool | Control whether BUM traffic is allowed between sites. The APIC defaults to C(false) when unset during creation. | ||
| allow_intersite_l2_stretch | bool | Allow L2 Stretch between sites. The APIC defaults to C(false) when unset during creation. | ||
| allow_ipv6_multicast | bool | Flag to indicate if ipv6 multicast is enabled. The APIC defaults to C(false) when unset during creation. | ||
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| arp_flooding | bool | Determines if the Bridge Domain should flood ARP traffic. The APIC defaults to C(false) when unset during creation. | ||
| bd | string | The name of the Bridge Domain. | ||
| bd_type | string | The type of traffic on the Bridge Domain. The APIC defaults to C(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 C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| description | string | Description for the Bridge Domain. | ||
| enable_multicast | bool | Determines if PIM is enabled. The APIC defaults to C(false) when unset during creation. | ||
| enable_rogue_except_mac | bool | Rogue exception MAC wildcard support for Bridge Domains. Only available in APIC version 6.0 or later. The APIC defaults to C(false) when unset during creation. | ||
| enable_routing | bool | Determines if IP forwarding should be allowed. The APIC defaults to C(true) when unset during creation. | ||
| endpoint_clear | bool | Clears all End Points in all Leaves when C(true). The value is not reset to disabled once End Points have been cleared; that requires a second task. The APIC defaults to C(false) when unset during creation. | ||
| endpoint_move_detect | string | Determines if GARP should be enabled to detect when End Points move. | ||
| endpoint_retention_action | string | Determines if the Bridge Domain should inherit or resolve the End Point Retention Policy. The APIC defaults to C(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. | ||
| first_hop_security_policy | string | The name of the First Hop Security Policy to apply to the Bridge Domain. To delete this attribute, pass an empty string. | ||
| host | 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 C(ACI_HOST) will be used instead. | ||
| host_based_routing | bool | Enables advertising host routes (/32 prefixes) out of the L3OUT(s) that are associated to this BD. The APIC defaults to C(false) when unset during creation. | ||
| igmp_policy | string | 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. | ||
| 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 | bool | Determines if the Bridge Domain should learn End Point IPs. The APIC defaults to C(true) when unset during creation. | ||
| ipv6_l3_unknown_multicast | string | Determines the forwarding method to use for IPv6 unknown multicast destinations. The APIC defaults to C(flood) 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 | Determines what forwarding method to use for unknown l2 destinations. The APIC defaults to C(proxy) when unset during creation. | ||
| l3_unknown_multicast | string | Determines the forwarding method to use for unknown multicast destinations. The APIC defaults to C(flood) when unset during creation. | ||
| limit_ip_learn | bool | Determines if the BD should limit IP learning to only subnets owned by the Bridge Domain. The APIC defaults to C(true) when unset during creation. | ||
| link_local_address | string | The override of the system generated IPv6 link-local address. | ||
| mac_address | string | The MAC Address to assign to the C(bd) instead of using the default. The APIC defaults to C(00:22:BD:F8:19:FF) when unset during creation. | ||
| mld_snoop_policy | string | 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. | ||
| monitoring_policy | string | The name of the Monitoring Policy to apply to the Bridge Domain. To delete this attribute, pass an empty string. | ||
| multi_dest | string | Determines the forwarding method for L2 multicast, broadcast, and link layer traffic. The APIC defaults to C(bd-flood) when unset during creation. | ||
| multicast_arp_drop | bool | Enable BD rogue multicast ARP packet drop. Only available in APIC version 6.0 or later. The APIC defaults to C(true) when unset during creation. | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| optimize_wan_bandwidth | bool | Optimize WAN Bandwidth improves the network application experience at the branch and makes better use of limited network resources. The APIC defaults to C(false) when unset during creation. | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| 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 C(ACI_OUTPUT_PATH) will be used instead. | ||
| 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 C(ACI_OWNER_KEY) will be used instead. | ||
| 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 C(ACI_OWNER_TAG) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| pim_destination_filter | string | 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. | ||
| pim_source_filter | string | 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 | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| 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 C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| route_profile | string | The Route Profile to associate with the Bridge Domain. | ||
| route_profile_l3out | string | The L3 Out that contains the associated Route Profile. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). 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. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). 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. | ||
| tenant | string | The name of the Tenant. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| use_proxy | bool | If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. | ||
| vlan | string | The selected VLAN for bridge domain access port encapsulation. To delete this attribute, pass an empty string. | ||
| vmac | string | Virtual MAC address of the BD/SVI. This is used when the BD is extended to multiple sites using L2 Outside. | ||
| vrf | string | The name of the VRF. |
Example
yaml
- {"cisco.aci.aci_bd": {"allow_intersite_bum_traffic": true, "allow_intersite_l2_stretch": true, "allow_ipv6_mcast": true, "bd": "web_servers", "first_hop_security_policy": "web_servers_fhs", "host": "{{ inventory_hostname }}", "host_based_routing": true, "igmp_policy": "web_servers_igmp_pol", "igmp_snoop_policy": "web_servers_igmp_snoop", "ll_addr": "fe80::1322:33ff:fe44:5566", "mac_address": "00:22:BD:F8:19:FE", "mld_snoop_policy": "web_servers_mld_snoop", "monitoring_policy": "web_servers_monitoring_pol", "optimize_wan_bandwidth": true, "password": "{{ password }}", "state": "present", "tenant": "prod", "username": "{{ username }}", "validate_certs": false, "vlan": "vlan-101", "vmac": "00:AA:BB:CC:DD:03", "vrf": "prod_vrf"}, "delegate_to": "localhost", "name": "Add Bridge Domain"}
- {"cisco.aci.aci_bd": {"bd": "storage", "bd_type": "fc", "enable_routing": false, "host": "{{ inventory_hostname }}", "password": "{{ password }}", "state": "present", "tenant": "prod", "username": "{{ username }}", "validate_certs": false, "vrf": "fc_vrf"}, "delegate_to": "localhost", "name": "Add an FC Bridge Domain"}
- {"cisco.aci.aci_bd": {"arp_flooding": true, "bd": "web_servers", "host": "{{ inventory_hostname }}", "l2_unknown_unicast": "flood", "password": "{{ password }}", "state": "present", "tenant": "prod", "username": "{{ username }}", "validate_certs": true}, "delegate_to": "localhost", "name": "Modify a Bridge Domain"}
- {"cisco.aci.aci_bd": {"arp_flooding": true, "bd": "web_servers", "first_hop_security_policy": "", "host": "{{ inventory_hostname }}", "l2_unknown_unicast": "flood", "mld_snoop_policy": "", "password": "{{ password }}", "state": "present", "tenant": "prod", "username": "{{ username }}", "validate_certs": true}, "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 }}", "password": "{{ password }}", "state": "query", "username": "{{ username }}", "validate_certs": true}, "delegate_to": "localhost", "name": "Query All Bridge Domains", "register": "query_result"}
- {"cisco.aci.aci_bd": {"bd": "web_servers", "host": "{{ inventory_hostname }}", "password": "{{ password }}", "state": "query", "tenant": "prod", "username": "{{ username }}", "validate_certs": true}, "delegate_to": "localhost", "name": "Query a Bridge Domain", "register": "query_result"}
- {"cisco.aci.aci_bd": {"bd": "web_servers", "host": "{{ inventory_hostname }}", "password": "{{ password }}", "state": "absent", "tenant": "prod", "username": "{{ username }}", "validate_certs": true}, "delegate_to": "localhost", "name": "Delete a Bridge Domain"}