#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2020, Sudhakar Shet Kudtarkar (@kudtarkar1) # Copyright: (c) 2020, Shreyas Srish # Copyright: (c) 2023, Akini Ross (@akinross) # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type ANSIBLE_METADATA = {"metadata_version": "1.1", "status": ["preview"], "supported_by": "community"} DOCUMENTATION = r""" --- module: aci_l3out_extepg_to_contract short_description: Bind Contracts to External End Point Groups (EPGs) (fv:RsCons, fv:RsProv, fv:RsProtBy, fv:RsConsIf, and fv:RsIntraEpg) description: - Bind Contracts to External End Point Groups (EPGs) on ACI fabrics. options: tenant: description: - Name of existing tenant. type: str l3out: description: - Name of the l3out. type: str aliases: [ l3out_name ] extepg: description: - Name of the external end point group. type: str aliases: [ extepg_name, external_epg] contract: description: - The name of the contract or contract interface. type: str aliases: [ contract_name, contract_interface ] contract_type: description: - Determines the type of the Contract. type: str required: true choices: [ consumer, provider, taboo, interface, intra_epg ] priority: description: - QoS class. - The APIC defaults to C(unspecified) when unset during creation. type: str choices: [ level1, level2, level3, level4, level5, level6, unspecified ] provider_match: description: - The matching algorithm for Provided Contracts. - The APIC defaults to C(at_least_one) when unset during creation. type: str choices: [ all, at_least_one, at_most_one, none ] contract_label: description: - Contract label to match. type: str subject_label: description: - Subject label to match. type: str 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 extends_documentation_fragment: - cisco.aci.aci - cisco.aci.annotation notes: - The C(tenant), C(l3out), C(extepg), and C(Contract) must exist before using this module in your playbook. The M(cisco.aci.aci_tenant), M(cisco.aci.aci_l3out), M(cisco.aci.aci_l3out_extepg), and M(cisco.aci.aci_contract) modules can be used for this. seealso: - name: APIC Management Information Model reference description: More information about the internal APIC class B(fv:RsCons), B(fv:RsProv), B(fv:RsProtBy, B(fv:RsConsIf, and B(fv:RsIntraEpg). link: https://developer.cisco.com/docs/apic-mim-ref/ author: - Sudhakar Shet Kudtarkar (@kudtarkar1) - Shreyas Srish (@shrsr) - Akini Ross (@akinross) """ EXAMPLES = r""" - name: Bind a contract to an external EPG cisco.aci.aci_l3out_extepg_to_contract: host: apic username: admin password: SomeSecretePassword tenant: Auto-Demo l3out: l3out extepg: testEpg contract: contract1 contract_type: provider state: present delegate_to: localhost - name: Remove existing contract from an external EPG cisco.aci.aci_l3out_extepg_to_contract: host: apic username: admin password: SomeSecretePassword tenant: Auto-Demo l3out: l3out extepg: testEpg contract: contract1 contract_type: provider state: absent delegate_to: localhost - name: Query a contract bound to an external EPG cisco.aci.aci_l3out_extepg_to_contract: host: apic username: admin password: SomeSecretePassword tenant: ansible_tenant l3out: ansible_l3out extepg: ansible_extEpg contract: ansible_contract contract_type: provider state: query delegate_to: localhost register: query_result - name: Query all contracts relationships cisco.aci.aci_l3out_extepg_to_contract: host: apic username: admin password: SomeSecretePassword contract_type: provider state: query delegate_to: localhost register: query_result """ RETURN = r""" 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 """ from ansible.module_utils.basic import AnsibleModule from ansible_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec, aci_annotation_spec from ansible_collections.cisco.aci.plugins.module_utils.constants import ACI_CLASS_MAPPING, CONTRACT_LABEL_MAPPING, PROVIDER_MATCH_MAPPING, SUBJ_LABEL_MAPPING def main(): argument_spec = aci_argument_spec() argument_spec.update(aci_annotation_spec()) argument_spec.update( contract_type=dict(type="str", required=True, choices=["consumer", "provider", "taboo", "interface", "intra_epg"]), l3out=dict(type="str", aliases=["l3out_name"]), contract=dict(type="str", aliases=["contract_name", "contract_interface"]), # Not required for querying all objects priority=dict(type="str", choices=["level1", "level2", "level3", "level4", "level5", "level6", "unspecified"]), provider_match=dict(type="str", choices=["all", "at_least_one", "at_most_one", "none"]), state=dict(type="str", default="present", choices=["absent", "present", "query"]), tenant=dict(type="str"), extepg=dict(type="str", aliases=["extepg_name", "external_epg"]), contract_label=dict(type="str"), subject_label=dict(type="str"), ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, required_if=[ ["state", "absent", ["extepg", "contract", "l3out", "tenant"]], ["state", "present", ["extepg", "contract", "l3out", "tenant"]], ], ) l3out = module.params.get("l3out") contract = module.params.get("contract") contract_type = module.params.get("contract_type") extepg = module.params.get("extepg") priority = module.params.get("priority") provider_match = module.params.get("provider_match") if provider_match is not None: provider_match = PROVIDER_MATCH_MAPPING.get(provider_match) state = module.params.get("state") tenant = module.params.get("tenant") contract_label = module.params.get("contract_label") subject_label = module.params.get("subject_label") aci_class = ACI_CLASS_MAPPING[contract_type]["class"] aci_rn = ACI_CLASS_MAPPING[contract_type]["rn"] aci_name = ACI_CLASS_MAPPING[contract_type]["name"] child_classes = [] if contract_type != "provider" and provider_match is not None: module.fail_json(msg="the 'provider_match' is only configurable for Provided Contracts") if contract_type in ["taboo", "interface", "intra_epg"] and (contract_label is not None or subject_label is not None): module.fail_json(msg="the 'contract_label' and 'subject_label' are not configurable for {0} contracts".format(contract_type)) if contract_type not in ["taboo", "interface", "intra_epg"]: contract_label_class = CONTRACT_LABEL_MAPPING.get(contract_type) subject_label_class = SUBJ_LABEL_MAPPING.get(contract_type) child_classes = [subject_label_class, contract_label_class] aci = ACIModule(module) aci.construct_url( root_class=dict( aci_class="fvTenant", aci_rn="tn-{0}".format(tenant), module_object=tenant, target_filter={"name": tenant}, ), subclass_1=dict( aci_class="l3extOut", aci_rn="out-{0}".format(l3out), module_object=l3out, target_filter={"name": l3out}, ), subclass_2=dict( aci_class="l3extInstP", aci_rn="instP-{0}".format(extepg), module_object=extepg, target_filter={"name": extepg}, ), subclass_3=dict( aci_class=aci_class, aci_rn="{0}{1}".format(aci_rn, contract), module_object=contract, target_filter={aci_name: contract}, ), child_classes=child_classes, ) aci.get_existing() if state == "present": child_configs = [] if contract_label is not None: child_configs.append({contract_label_class: {"attributes": {"name": contract_label}}}) if subject_label is not None: child_configs.append({subject_label_class: {"attributes": {"name": subject_label}}}) aci.payload( aci_class=aci_class, class_config={"matchT": provider_match, "prio": priority, aci_name: contract}, child_configs=child_configs, ) aci.get_diff(aci_class=aci_class) aci.post_config() elif state == "absent": aci.delete_config() aci.exit_json() if __name__ == "__main__": main()