#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2023, Gaspard Micol (@gmicol) # 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_qos_custom_policy short_description: Manage QoS Custom Policy (qos:CustomPol) description: - Manage QoS Custom Policies for tenants on Cisco ACI fabrics. - The custom QoS policy enables different levels of service to be assigned to network traffic, including specifications for the Differentiated Services Code Point (DSCP) value(s), and the 802.1p Dot1p priority. options: tenant: description: - The name of an existing tenant. type: str aliases: [ tenant_name ] qos_custom_policy: description: - The name of the QoS Custom Policy. type: str aliases: [ qos_custom_policy_name, name ] description: description: - The description for the QoS Custom Policy. type: str aliases: [ descr ] 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 - cisco.aci.owner notes: - The I(tenant) must exist before using this module in your playbook. The M(cisco.aci.aci_tenant) 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(qos:CustomPol). link: https://developer.cisco.com/docs/apic-mim-ref/ author: - Gaspard Micol (@gmicol) """ EXAMPLES = r""" - name: Add a new QoS Custom Policy cisco.aci.aci_qos_custom_policy: host: apic username: admin password: SomeSecretPassword tenant: my_tenant qos_custom_policy: my_qos_custom_policy state: present delegate_to: localhost - name: Query a QoS Custom Policy cisco.aci.aci_qos_custom_policy: host: apic username: admin password: SomeSecretPassword tenant: my_tenant qos_custom_policy: my_qos_custom_policy state: query delegate_to: localhost - name: Query all QoS Custom Policies in my_tenant cisco.aci.aci_qos_custom_policy: host: apic username: admin password: SomeSecretPassword tenant: my_tenant state: query delegate_to: localhost - name: Query all QoS Custom Policies cisco.aci.aci_qos_custom_policy: host: apic username: admin password: SomeSecretPassword state: query delegate_to: localhost - name: Delete a QoS Custom Policy cisco.aci.aci_qos_custom_policy: host: apic username: admin password: SomeSecretPassword tenant: my_tenant qos_custom_policy: my_qos_custom_policy 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, aci_owner_spec def main(): argument_spec = aci_argument_spec() argument_spec.update(aci_annotation_spec()) argument_spec.update(aci_owner_spec()) argument_spec.update( tenant=dict(type="str", aliases=["tenant_name"]), qos_custom_policy=dict(type="str", aliases=["qos_custom_policy_name", "name"]), description=dict(type="str", aliases=["descr"]), state=dict(type="str", default="present", choices=["absent", "present", "query"]), ) module = AnsibleModule( argument_spec=argument_spec, supports_check_mode=True, required_if=[ ["state", "absent", ["tenant", "qos_custom_policy"]], ["state", "present", ["tenant", "qos_custom_policy"]], ], ) tenant = module.params.get("tenant") description = module.params.get("description") qos_custom_policy = module.params.get("qos_custom_policy") state = module.params.get("state") 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="qosCustomPol", aci_rn="qoscustom-{0}".format(qos_custom_policy), module_object=qos_custom_policy, target_filter={"name": qos_custom_policy}, ), ) aci.get_existing() if state == "present": aci.payload( aci_class="qosCustomPol", class_config=dict( name=qos_custom_policy, descr=description, ), ) aci.get_diff(aci_class="qosCustomPol") aci.post_config() elif state == "absent": aci.delete_config() aci.exit_json() if __name__ == "__main__": main()