Vhe z d dl mZmZmZ eZddgddZdZdZdZ d d l
m Z d d
l m
Z
mZmZmZ d Zed k( r e y
y
) )absolute_importdivisionprint_functionz1.1preview certified)metadata_versionstatus supported_bya"
---
module: aci_bd
short_description: Manage Bridge Domains (BD) objects (fv:BD)
description:
- Manages Bridge Domains (BD) on Cisco ACI fabrics.
options:
arp_flooding:
description:
- Determines if the Bridge Domain should flood ARP traffic.
- The APIC defaults to C(false) when unset during creation.
type: bool
bd:
description:
- The name of the Bridge Domain.
type: str
aliases: [ bd_name, name ]
bd_type:
description:
- The type of traffic on the Bridge Domain.
- The APIC defaults to C(ethernet) when unset during creation.
type: str
choices: [ ethernet, fc ]
description:
description:
- Description for the Bridge Domain.
type: str
enable_multicast:
description:
- Determines if PIM is enabled.
- The APIC defaults to C(false) when unset during creation.
type: bool
enable_routing:
description:
- Determines if IP forwarding should be allowed.
- The APIC defaults to C(true) when unset during creation.
type: bool
endpoint_clear:
description:
- 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.
type: bool
endpoint_move_detect:
description:
- Determines if GARP should be enabled to detect when End Points move.
type: str
choices: [ default, garp ]
endpoint_retention_action:
description:
- Determines if the Bridge Domain should inherit or resolve the End Point Retention Policy.
- The APIC defaults to C(resolve) when unset during creation.
type: str
choices: [ inherit, 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.
type: str
igmp_snoop_policy:
description:
- The name of the IGMP Snooping Policy the Bridge Domain should use when
overriding the default IGMP Snooping Policy.
type: str
ip_learning:
description:
- Determines if the Bridge Domain should learn End Point IPs.
- The APIC defaults to C(true) when unset during creation.
type: bool
ipv6_nd_policy:
description:
- The name of the IPv6 Neighbor Discovery Policy the Bridge Domain should use when
overridding the default IPV6 ND Policy.
type: str
l2_unknown_unicast:
description:
- Determines what forwarding method to use for unknown l2 destinations.
- The APIC defaults to C(proxy) when unset during creation.
type: str
choices: [ proxy, flood ]
l3_unknown_multicast:
description:
- Determines the forwarding method to use for unknown multicast destinations.
- The APIC defaults to C(flood) when unset during creation.
type: str
choices: [ flood, opt-flood ]
ipv6_l3_unknown_multicast:
description:
- Determines the forwarding method to use for IPv6 unknown multicast destinations.
- The APIC defaults to C(flood) when unset during creation.
type: str
choices: [ flood, opt-flood ]
limit_ip_learn:
description:
- 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.
type: bool
mac_address:
description:
- 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.
type: str
aliases: [ mac ]
multi_dest:
description:
- Determines the forwarding method for L2 multicast, broadcast, and link layer traffic.
- The APIC defaults to C(bd-flood) when unset during creation.
type: str
choices: [ bd-flood, drop, encap-flood ]
state:
description:
- Use C(present) or C(absent) for adding or removing.
- Use C(query) for listing an object or multiple objects.
type: str
choices: [ absent, present, query ]
default: present
name_alias:
description:
- The alias for the current object. This relates to the nameAlias field in ACI.
type: str
tenant:
description:
- The name of the Tenant.
type: str
aliases: [ tenant_name ]
vrf:
description:
- The name of the VRF.
type: str
aliases: [ vrf_name ]
route_profile:
description:
- The Route Profile to associate with the Bridge Domain.
type: str
route_profile_l3out:
description:
- The L3 Out that contains the associated Route Profile.
type: str
host_based_routing:
description:
- 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.
type: bool
aliases: [ advertise_host_routes ]
enable_rogue_except_mac:
description:
- 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.
type: bool
allow_intersite_bum_traffic:
description:
- Control whether BUM traffic is allowed between sites.
- The APIC defaults to C(false) when unset during creation.
type: bool
aliases: [allow_bum_traffic]
allow_intersite_l2_stretch:
description:
- Allow L2 Stretch between sites.
- The APIC defaults to C(false) when unset during creation.
type: bool
aliases: [allow_l2_stretch]
allow_ipv6_multicast:
description:
- Flag to indicate if ipv6 multicast is enabled.
- The APIC defaults to C(false) when unset during creation.
type: bool
aliases: [ ipv6_multicast, ipv6_mcast, allow_ipv6_mcast]
link_local_address:
description:
- The override of the system generated IPv6 link-local address.
type: str
aliases: [ ll_addr_ipv6, ll_addr, link_local]
multicast_arp_drop:
description:
- 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.
type: bool
aliases: [ mcast_arp_drop ]
vmac:
description:
- Virtual MAC address of the BD/SVI. This is used when the BD is extended to multiple sites using L2 Outside.
type: str
optimize_wan_bandwidth:
description:
- 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.
type: bool
aliases: [wan_optimization, opt_bandwidth]
mld_snoop_policy:
description:
- 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.
type: str
aliases: [mld_snoop, mld_policy]
igmp_policy:
description:
- 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.
type: str
aliases: [igmp]
vlan:
description:
- The selected VLAN for bridge domain access port encapsulation.
- To delete this attribute, pass an empty string.
type: str
aliases: [encap]
monitoring_policy:
description:
- The name of the Monitoring Policy to apply to the Bridge Domain.
- To delete this attribute, pass an empty string.
type: str
aliases: [mon_pol, monitoring_pol]
first_hop_security_policy:
description:
- The name of the First Hop Security Policy to apply to the Bridge Domain.
- To delete this attribute, pass an empty string.
type: str
aliases: [fhsp, fhs_pol, fhsp_name]
pim_source_filter:
description:
- 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.
type: str
aliases: [pim_source]
pim_destination_filter:
description:
- 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.
type: str
aliases: [pim_dest, pim_destination]
extends_documentation_fragment:
- cisco.aci.aci
- cisco.aci.annotation
- cisco.aci.owner
notes:
- The C(tenant) used must exist before using this module in your playbook.
The M(cisco.aci.aci_tenant) module can be used for this.
seealso:
- module: cisco.aci.aci_tenant
- name: APIC Management Information Model reference
description: More information about the internal APIC class B(fv:BD).
link: https://developer.cisco.com/docs/apic-mim-ref/
author:
- Jacob McGill (@jmcgill298)
- Samita Bhattacharjee (@samitab)
a6
- 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
a
current:
description: The existing configuration from the APIC after the module has finished
returned: success
type: list
sample:
[
{
"fvTenant": {
"attributes": {
"descr": "Production environment",
"dn": "uni/tn-production",
"name": "production",
"nameAlias": "",
"ownerKey": "",
"ownerTag": ""
}
}
}
]
error:
description: The error information as returned from the APIC
returned: failure
type: dict
sample:
{
"code": "122",
"text": "unknown managed object class foo"
}
raw:
description: The raw output returned by the APIC REST API (xml or json)
returned: parse error
type: str
sample: ''
sent:
description: The actual/minimal configuration pushed to the APIC
returned: info
type: list
sample:
{
"fvTenant": {
"attributes": {
"descr": "Production environment"
}
}
}
previous:
description: The original configuration from the APIC before the module has started
returned: info
type: list
sample:
[
{
"fvTenant": {
"attributes": {
"descr": "Production",
"dn": "uni/tn-production",
"name": "production",
"nameAlias": "",
"ownerKey": "",
"ownerTag": ""
}
}
}
]
proposed:
description: The assembled configuration from the user-provided parameters
returned: info
type: dict
sample:
{
"fvTenant": {
"attributes": {
"descr": "Production environment",
"name": "production"
}
}
}
filter_string:
description: The filter string used for the request
returned: failure or debug
type: str
sample: ?rsp-prop-include=config-only
method:
description: The HTTP method used for the request to the APIC
returned: failure or debug
type: str
sample: POST
response:
description: The HTTP response from the APIC
returned: failure or debug
type: str
sample: OK (30 bytes)
status:
description: The HTTP status from the APIC
returned: failure or debug
type: int
sample: 200
url:
description: The HTTP url used for the request to the APIC
returned: failure or debug
type: str
sample: https://10.11.12.13/api/mo/uni/tn-production.json
)
AnsibleModule) ACIModuleaci_argument_specaci_annotation_specaci_owner_specc t } | j t | j t | j di dt d dt dddg d t dd
d g d
t d dt d dt d dt d dt dddg dt dddg dt d dt d dt d dt d dt dd d g d t dd d g d t dd d g d!t d d"t dd#g d$t dg d% d&t dd'g d() d*t dd+g d,t dd-g d.t d d/t d d0t d d1t dd2g d3t d d4t dd5g d6t dd7g d8t dg d9 d:t dg d; dt d d?t dd@dAg dBt ddCdDg dEt ddFg dGt ddHg dIt ddJdKg dLt dg dM dNt ddOg dPt ddQdRg t | dSd&dTdd*ggd&d'dd*gggU }t
| }|j |j j d }|j j d }|j j d }|d
k( rdV}|j j d
}|j |j j d }|j |j j d }|j |j j d } |j j d }
|
dk( rdW}
|j j d } |j j d } |j j d }
|j |j j d }|j j d }|j j d }|j j d }|j j d }|j |j j d! }|j j d" }|j j d$ }|j j d& }|j j d* }|j j d, }|j j d. }|j j d/ }|j j d0 }|j |j j d1 } |j |j j d3 } |j |j j d4 } |j |j j d6 } |j |j j d8 } |j j d: }!|j |j j d< }"|j j d> }#|j |j j d? }$|j j dB }%|j j dE }&|j j dG }'|j j dI }(|j j dL })|j j dN }*|j j dP }+g dX},|*|+|,j g dY |j t dZd[j | |d|i\ t d]d^j | |d|i\ |,_ |j |d'k( rt di d`|da|db| dc|
dd|de|d#|df|dg|d|dh|di|dj|dk|dl|dm| dn| do| dp| dq| dr|!ds|"d>|#dt|$}-|||-du< dvdwdx|iiidydwdz|
iiid{dwd||%iiid}dwd~|iiiddw| | diiddw||diiddwd|)iiiddwdH|'iiiddwd|(iiig }.|&6|&dWk( rdWndj ||& }/|.j di ddwd|/iiigdi |*|+di g di}0di g di}1|*<|*dWk( rdWndj ||* }2|1d d j di ddwd|2iiigdi |+<|+dWk( rdWndj ||+ }3|1d d j di ddwd|3iiigdi |0d d j |1 |.j |0 |j d]|-|. |j! d] |j# n|dTk( r|j% |j' y )N arp_floodingbool)typebdstrbd_namename)r aliasesbd_typeethernetfc)r choices descriptionenable_multicastenable_routingendpoint_clearendpoint_move_detectdefaultgarpendpoint_retention_actioninheritresolveendpoint_retention_policyigmp_snoop_policy ip_learningipv6_nd_policyl2_unknown_unicastproxyfloodl3_unknown_multicastz opt-floodipv6_l3_unknown_multicastlimit_ip_learn mac_addressmac
multi_dest)zbd-flooddropz encap-floodstatepresent)absentr6 query)r r" r tenant tenant_namevrfvrf_name
route_profileroute_profile_l3out
name_aliashost_based_routingadvertise_host_routesenable_rogue_except_macallow_intersite_bum_trafficallow_bum_trafficallow_intersite_l2_stretchallow_l2_stretchallow_ipv6_multicast)ipv6_multicast
ipv6_mcastallow_ipv6_mcastlink_local_address) ll_addr_ipv6ll_addr
link_localmulticast_arp_dropmcast_arp_dropvmacoptimize_wan_bandwidthwan_optimization
opt_bandwidthmld_snoop_policy mld_snoop
mld_policy igmp_policyigmpvlanencapmonitoring_policymon_polmonitoring_polfirst_hop_security_policy)fhspfhs_pol fhsp_namepim_source_filter
pim_sourcepim_destination_filterpim_destpim_destinationTr7 )
argument_specsupports_check_mode required_ifregular ) fvRsCtx
fvRsIgmpsn fvRsBDToNdP
fvRsBdToEpRetfvRsBDToProfile fvRsMldsnigmpIfP igmpRsIfPolfvAccPfvRsABDPolMonPol fvRsBDToFhs)pimBDPpimBDFilterPolpimBDSrcFilterPolpimBDDestFilterPolrtdmcRsFilterToRtMapPolfvTenantztn-{0}) aci_classaci_rn
module_object
target_filterfvBDzBD-{0})
root_class
subclass_1
child_classesarpFlooddescrepClearepMoveDetectMode
ipLearninglimitIpLearnToSubnets
mcastAllowmultiDstPktActr unicastRouteunkMacUcastAct unkMcastAct nameAliasenableRogueExceptMachostBasedRoutingintersiteBumTrafficAllowintersiteL2Stretchipv6McastAllowllAddr mcastARPDropOptimizeWanBandwidth
v6unkMcastActrm
attributes tnFvCtxNamern tnIgmpSnoopPolNamerr tnMldSnoopPolNamero
tnNdIfPolNamerp )
resolveActtnFvEpRetPolNamerq )tnL3extOutNametnRtctrlProfileNamerw tnFhsBDPolNameru rv tnMonEPGPolNamezuni/tn-{0}/igmpIfPol-{1}rs rt tDn)r childrenrx ry zuni/tn-{0}/rtmap-{1}r rz r| r{ )r~ class_config
child_configs)r~ )r
updater r dictr r booleanparamsgetextend
construct_urlformat get_existingappendpayloadget_diff post_config
delete_config exit_json)4rh moduleacir r r r r r r r! r$ r' r( r) r* r+ r. r/ r0 r1 r3 r5 r9 r; r= r> r? r@ rB rC rE rG rK rO rQ rR rU rX rZ r\ r_ rc re r r r igmp_policy_tdnpim_bdpim_filter_polpim_source_filter_tdnpim_destination_filter_tdns4 d/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_bd.pymainr s %'M,./ )*M *v&* UY$7 8* %*d);<* e$ *
6* * (
* (* "uy&6I J* #'EIy;Q"R* #'E"2* E** f%* '* UWg4FG * "uw 6L M * #'EG[;Q"R!*" (#*$ eeW5%*& U,OP'*( y:XY)** 8+*,
ej\ 2-*. &/*0 !e ,1*2 U#3*4 V6M5NO5*6 !%& 17*8 %)f?R>S$T9*: $(V>P=Q#R;*< "v7k l=*> U4]^?*@ V6F5GHA*B u
C*D $:Lo9^ _E*F 5; 2MNG*H efX6I*J uwi
0K*L EI?O3PQM*N #'E;["\O*P EL>BQ*R $EV8W XS*X #
hx 0 1
i$!1 2
F F
C;;v}} 0 0 @AL 4 Bmm *G* --##M2K{{6==#4#45G#HI[[ !2!23C!DEN[[ !2!23C!DEN!==,,-CDy( ! &
1 12M N &
1 12M N
))*=>++fmm / /
>?K]]&&'78N **+?@!==,,-CD &
1 12M N [[ !2!23C!DEN--##M2K ""<0J MM g &E
]]
x
(F
--
E
"CMM%%o6M --++,AB ""<0J V]]%6%67K%LM !kk&--*;*;->?[-\!] ;;v}}'8'89O'PQ **+?@ V]]%6%67K%LM == V $D [[ ):):;S)T U }}(();<--##M2K == V $D
))*=> &
1 12M N
))*=> #]] . ./G H M $(>(J
??6* !6*
??2& !2,
$
!
#
2
#
#1
(
&
(
.
-
!
"9!
" 0#
$ &A%
& :'
( 0)
* &+
, ,-
. /
0 "81
6 % 0,EL )
s';< =
L+?AR*ST U
<*=?O)PQ R
\O^+L M N
|W+X Y Z
wo6 7
,1BDU0V!W X
"$/2$5b;U;\;\]cep;qO )Bm^jmr uD mE ^F NG MH .I "J
K (,B,N rr BCF .rr0R SN ,.?2.EKaKhKhio rC LD% /0<CC(Kdgsv{ ~S vT gU KV JW +X Y &13IR3ORUkUrUrsy |R VS* /0<CC)"Lehtw| Y wZ h[ L\ K] ,^ _
8 Z ( / / ? ( f<} ] v & ( MMO __main__N)
__future__r r r r
__metaclass__ANSIBLE_METADATA
DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicr 6ansible_collections.cisco.aci.plugins.module_utils.acir r
r r r __name__r r r r sj A @
(-)Vab {
ze Ng
R 5 E E\~ zF r