#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2022, Sabari Jaganathan (@sajagana) # 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": "certified"} DOCUMENTATION = r""" --- module: aci_esg_epg_selector short_description: Manage ESG - EPG Selectors (fv:EPgSelector) description: - Manage Endpoint Security Groups - EPG Selectors on Cisco ACI fabrics. options: tenant: description: - Name of the tenant. type: str aliases: [ tenant_name ] ap: description: - The name of the application profile. type: str aliases: [ app_profile, app_profile_name ] esg: description: - Name of the Endpoint Security Group. type: str aliases: [ esg_name ] epg_ap: description: - Name of the Application profile which contains the EPG. type: str epg: description: - Name of the EPG which is used to create EPG Selector object under the ESG. type: str aliases: [ epg_name ] description: description: - Description of the ESG Tag Selector. type: str aliases: [ epg_selector_description ] 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 extends_documentation_fragment: - cisco.aci.aci - cisco.aci.annotation seealso: - module: cisco.aci.aci_esg - name: Manage Endpoint Security Groups (ESGs) objects (fv:ESg) description: Manage Endpoint Security Groups (ESGs) on Cisco ACI fabrics. link: https://developer.cisco.com/docs/apic-mim-ref/ author: - Sabari Jaganathan (@sajagana) """ EXAMPLES = r""" - name: Add an EPG selector cisco.aci.aci_esg_epg_selector: host: apic username: admin password: SomeSecretPassword tenant: production ap: production_ap esg: web_esg epg_ap: production_ap1 epg: production_ap1-epg description: epg-test-description state: present delegate_to: localhost - name: Add list of EPG selectors cisco.aci.aci_esg_epg_selector: host: apic username: admin password: SomeSecretPassword tenant: production ap: production_ap esg: "{{ item.esg }}" epg_ap: "{{ item.epg_ap }}" epg: "{{ item.epg }}" description: epg-test-description state: present delegate_to: localhost with_items: - {"epg_ap": "production_ap1", "epg": "epg-test1", "esg": "web_esg"} - {"epg_ap": "production_ap1", "epg": "epg-test2", "esg": "web_esg"} - name: Query an EPG selector with esg and epg name cisco.aci.aci_esg_epg_selector: host: apic username: admin password: SomeSecretPassword tenant: production ap: production_ap esg: web_esg epg_ap: production_ap1 epg: production_ap1-epg state: query delegate_to: localhost - name: Query all EPG selectors under a application profile cisco.aci.aci_esg_epg_selector: host: apic username: admin password: SomeSecretPassword tenant: production ap: production_ap state: query delegate_to: localhost - name: Query all EPG selectors cisco.aci.aci_esg_epg_selector: host: apic username: admin password: SomeSecretPassword state: query delegate_to: localhost - name: Remove an EPG selector cisco.aci.aci_esg_epg_selector: host: apic username: admin password: SomeSecretPassword tenant: production ap: production_ap esg: web_esg epg_ap: production_ap1 epg: production_ap1-epg state: absent delegate_to: localhost """ 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 def main(): argument_spec = aci_argument_spec() argument_spec.update(aci_annotation_spec()) argument_spec.update( tenant=dict(type="str", aliases=["tenant_name"]), ap=dict(type="str", aliases=["app_profile", "app_profile_name"]), esg=dict(type="str", aliases=["esg_name"]), epg_ap=dict(type="str"), epg=dict(type="str", aliases=["epg_name"]), description=dict(type="str", aliases=["epg_selector_description"]), state=dict( type="str", default="present", choices=["absent", "present", "query"], ), name_alias=dict(type="str"), ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, required_if=[ ["state", "absent", ["tenant", "ap", "esg", "epg", "epg_ap"]], ["state", "present", ["tenant", "ap", "esg", "epg", "epg_ap"]], ], ) aci = ACIModule(module) tenant = module.params.get("tenant") ap = module.params.get("ap") esg = module.params.get("esg") epg_ap = module.params.get("epg_ap") epg = module.params.get("epg") description = module.params.get("description") state = module.params.get("state") matchEpgDn = "uni/tn-{0}/ap-{1}/epg-{2}".format(tenant, epg_ap, epg) epgselector = "epgselector-[{0}]".format(matchEpgDn) 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="fvAp", aci_rn="ap-{0}".format(ap), module_object=ap, target_filter={"name": ap}, ), subclass_2=dict( aci_class="fvESg", aci_rn="esg-{0}".format(esg), module_object=esg, target_filter={"name": esg}, ), subclass_3=dict( aci_class="fvEPgSelector", aci_rn=epgselector, module_object=epg, target_filter={"matchEpgDn": epg}, ), ) aci.get_existing() if state == "present": aci.payload( aci_class="fvEPgSelector", class_config=dict( matchEpgDn=matchEpgDn, descr=description, ), ) aci.get_diff(aci_class="fvEPgSelector") aci.post_config() elif state == "absent": aci.delete_config() aci.exit_json() if __name__ == "__main__": main()