#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2021, Cindy Zhao # 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 DOCUMENTATION = r""" --- module: aci_cloud_epg_selector short_description: Manage Cloud Endpoint Selector (cloud:EPSelector) description: - Manage Cloud Endpoint Selector on Cisco Cloud ACI notes: - More information about the internal APIC class B(cloud:EPSelector) from L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/). author: - Cindy Zhao (@cizhao) options: description: description: - Description of the Cloud Endpoint Selector. type: str expressions: description: - Expressions associated to this selector. type: list elements: dict suboptions: key: description: - The key of the expression. - The key is custom or is one of region, zone and ip - The key can be zone only when the site is AWS. required: true type: str operator: description: - The operator associated to the expression. - Operator C(has_key) or C(does_not_have_key) is only available for key custom or zone required: true type: str choices: [ not_in, in, equals, not_equals, has_key, does_not_have_key ] value: description: - The value associated to the expression. - If the operator is C(in) or C(not_in), the value should be a comma separated string. type: str name: description: - The name of the Cloud Endpoint selector. aliases: [ selector, selector_name ] type: str tenant: description: - The name of the existing tenant. required: true type: str ap: description: - The name of the cloud application profile. required: true type: str epg: description: - The name of the cloud EPG. required: true type: str state: description: - Use C(present) or C(absent) for adding or removing. - Use C(query) for listing an object or multiple objects. choices: [ absent, present, query ] default: present type: str extends_documentation_fragment: - cisco.aci.aci - cisco.aci.annotation - cisco.aci.owner """ EXAMPLES = r""" - name: Create aci cloud epg selector cisco.aci.aci_cloud_epg_selector: host: apic username: admin password: SomeSecretPassword tenant: tenantName ap: apName epg: epgName description: cloud epg selector name: selectorName expressions: - key: ip operator: in value: 10.10.10.1 state: present delegate_to: localhost - name: Remove cloud epg selector cisco.aci.aci_cloud_epg_selector: host: apic username: admin password: SomeSecretPassword tenant: tenantName ap: apName epg: epgName name: selectorName state: absent delegate_to: localhost - name: query all cisco.aci.aci_cloud_epg: host: apic username: admin password: SomeSecretPassword tenant: tenantName ap: apName epg: epgName state: query delegate_to: localhost - name: query a specific cloud epg selector cisco.aci.aci_cloud_epg: host: apic username: admin password: SomeSecretPassword tenant: tenantName ap: apName epg: epgName name: selectorName state: query 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_collections.cisco.aci.plugins.module_utils.aci import ACIModule, aci_argument_spec, expression_spec, aci_annotation_spec, aci_owner_spec from ansible.module_utils.basic import AnsibleModule EXPRESSION_KEYS = { "ip": "IP", "region": "Region", "zone": "Zone", } EXPRESSION_OPERATORS = { "not_in": "notin", "not_equals": "!=", "in": "in", "equals": "==", } def main(): argument_spec = aci_argument_spec() argument_spec.update(aci_annotation_spec()) argument_spec.update(aci_owner_spec()) argument_spec.update( { "description": dict(type="str"), "expressions": dict(type="list", elements="dict", options=expression_spec()), "name": dict(type="str", aliases=["selector", "selector_name"]), "tenant": dict(type="str", required=True), "ap": dict(type="str", required=True), "epg": dict(type="str", required=True), "state": dict(type="str", default="present", choices=["absent", "present", "query"]), } ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, required_if=[ ["state", "absent", ["name"]], ["state", "present", ["name"]], ], ) description = module.params.get("description") expressions = module.params.get("expressions") name = module.params.get("name") tenant = module.params.get("tenant") ap = module.params.get("ap") epg = module.params.get("epg") state = module.params.get("state") child_configs = [] aci = ACIModule(module) aci.construct_url( root_class={ "aci_class": "fvTenant", "aci_rn": "tn-{0}".format(tenant), "target_filter": 'eq(fvTenant.name, "{0}")'.format(tenant), "module_object": tenant, }, subclass_1={"aci_class": "cloudApp", "aci_rn": "cloudapp-{0}".format(ap), "target_filter": 'eq(cloudApp.name, "{0}")'.format(ap), "module_object": ap}, subclass_2={ "aci_class": "cloudEPg", "aci_rn": "cloudepg-{0}".format(epg), "target_filter": 'eq(cloudEPg.name, "{0}")'.format(epg), "module_object": epg, }, subclass_3={ "aci_class": "cloudEPSelector", "aci_rn": "epselector-{0}".format(name), "target_filter": 'eq(cloudEPSelector.name, "{0}")'.format(name), "module_object": name, }, child_classes=[], ) aci.get_existing() if state == "present": expressions_list = [] for expression in expressions: key = expression.get("key") operator = expression.get("operator") if expression.get("value"): value = "'" + "','".join(expression.get("value").split(",")) + "'" else: value = None if operator in ["has_key", "does_not_have_key"]: if value: module.fail_json(msg="Attribute 'value' is not supported for operator '{0}' in expression '{1}'".format(operator, key)) if key in ["ip", "region"]: module.fail_json(msg="Operator '{0}' is not supported when expression key is '{1}'".format(operator, key)) if operator in ["not_in", "in", "equals", "not_equals"] and not value: module.fail_json(msg="Attribute 'value' needed for operator '{0}' in expression '{1}'".format(operator, key)) if key in ["ip", "region", "zone"]: key = EXPRESSION_KEYS.get(key) else: key = "custom:" + key if operator in ["not_in", "in"]: expressions_list.append("{0} {1}({2})".format(key, EXPRESSION_OPERATORS.get(operator), value)) elif operator in ["equals", "not_equals"]: expressions_list.append("{0}{1}{2}".format(key, EXPRESSION_OPERATORS.get(operator), value)) elif operator == "does_not_have_key": expressions_list.append("!{0}".format(key)) else: expressions_list.append(key) matchExpression = ",".join(expressions_list) aci.payload( aci_class="cloudEPSelector", class_config={ "descr": description, "matchExpression": matchExpression, "name": name, }, child_configs=child_configs, ) aci.get_diff(aci_class="cloudEPSelector") aci.post_config() elif state == "absent": aci.delete_config() aci.exit_json() if __name__ == "__main__": main()