diff --git a/plugins/modules/ndo_dhcp_option_policy.py b/plugins/modules/ndo_dhcp_option_policy.py new file mode 100644 index 00000000..79a828b0 --- /dev/null +++ b/plugins/modules/ndo_dhcp_option_policy.py @@ -0,0 +1,247 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# Copyright: (c) 2024, 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: ndo_dhcp_option_policy +short_description: Manage DHCP Option Policies on Cisco Nexus Dashboard Orchestrator (NDO). +description: +- Manage DHCP Option Policies on Cisco Nexus Dashboard Orchestrator (NDO). +author: +- Akini Ross (@akinross) +options: + template: + description: + - The name of the template. + - The template must be a tenant template. + type: str + required: true + option_policy: + description: + - The name of the DHCP Option Policy. + type: str + aliases: [ name ] + option_policy_uuid: + description: + - The uuid of the DHCP Option Policy. + - This parameter is required when the O(option_policy) needs to be updated. + type: str + aliases: [ uuid ] + description: + description: + - The description of the DHCP Option Policy. + type: str + options: + description: + - A list of options attached to the DHCP Option Policy. + - The list of configured options must contain at least one option. + - When the list of options is null the update will not change existing option configuration. + type: list + elements: dict + suboptions: + name: + description: + - The name of the option. + type: str + required: true + id: + description: + - The id of the option. + type: int + data: + description: + - The data of the option. + type: str + state: + description: + - Use C(absent) for removing. + - Use C(query) for listing an object or multiple objects. + - Use C(present) for creating or updating. + type: str + choices: [ absent, query, present ] + default: query +extends_documentation_fragment: cisco.mso.modules +""" + +EXAMPLES = r""" +- name: Create a new dhcp option policy + cisco.mso.ndo_dhcp_option_policy: + host: mso_host + username: admin + password: SomeSecretPassword + template: ansible_tenant_template + option_policy: ansible_test_option_policy + options: + - name: option_1 + id: 1 + data: data_1 + state: present + +- name: Query a dhcp option policy with template_name + cisco.mso.ndo_dhcp_option_policy: + host: mso_host + username: admin + password: SomeSecretPassword + template: ansible_tenant_template + option_policy: ansible_test_option_policy + state: query + register: query_one + +- name: Query all dhcp option policy in the template + cisco.mso.ndo_dhcp_option_policy: + host: mso_host + username: admin + password: SomeSecretPassword + template: ansible_tenant_template + state: query + register: query_all + +- name: Delete a dhcp option policy + cisco.mso.ndo_dhcp_option_policy: + host: mso_host + username: admin + password: SomeSecretPassword + template: ansible_tenant_template + option_policy: ansible_test_option_policy + state: absent +""" + +RETURN = r""" +""" + + +import copy +from ansible.module_utils.basic import AnsibleModule +from ansible_collections.cisco.mso.plugins.module_utils.mso import MSOModule, mso_argument_spec +from ansible_collections.cisco.mso.plugins.module_utils.template import MSOTemplate, KVPair + + +def main(): + argument_spec = mso_argument_spec() + argument_spec.update( + template=dict(type="str", required=True), + option_policy=dict(type="str", aliases=["name"]), + option_policy_uuid=dict(type="str", aliases=["uuid"]), + description=dict(type="str"), + options=dict( + type="list", + elements="dict", + options=dict( + name=dict(type="str", required=True), + id=dict(type="int"), + data=dict(type="str"), + ), + ), + state=dict(type="str", default="query", choices=["absent", "query", "present"]), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + supports_check_mode=True, + required_if=[ + ["state", "absent", ["option_policy"]], + ["state", "present", ["option_policy"]], + ], + ) + + mso = MSOModule(module) + + template = module.params.get("template") + option_policy = module.params.get("option_policy") + option_policy_uuid = module.params.get("option_policy_uuid") + options = get_options_payload(module.params.get("options")) if module.params.get("options") else [] + description = module.params.get("description") + state = module.params.get("state") + + ops = [] + match = None + err_message_min_options = "At least one option is required when state is present." + + mso_template = MSOTemplate(mso, "tenant", template) + mso_template.validate_template("tenantPolicy") + + path = "/tenantPolicyTemplate/template/dhcpOptionPolicies" + existing_dhcp_option_policies = mso_template.template.get("tenantPolicyTemplate", {}).get("template", {}).get("dhcpOptionPolicies", []) + if option_policy: + object_description = "DHCP Option Policy" + if option_policy_uuid: + match = mso_template.get_object_by_uuid(object_description, existing_dhcp_option_policies, option_policy_uuid) + else: + kv_list = [KVPair("name", option_policy)] + match = mso_template.get_object_by_key_value_pairs(object_description, existing_dhcp_option_policies, kv_list) + if match: + mso.existing = mso.previous = copy.deepcopy(match.details) + else: + mso.existing = mso.previous = existing_dhcp_option_policies + + if state == "present": + + if match: + + if module.params.get("options") is not None and len(options) == 0: + mso.fail_json(msg=err_message_min_options) + + if option_policy and match.details.get("name") != option_policy: + ops.append(dict(op="replace", path="{0}/{1}/name".format(path, match.index), value=option_policy)) + match.details["name"] = option_policy + + if description is not None and match.details.get("description") != description: + ops.append(dict(op="replace", path="{0}/{1}/description".format(path, match.index), value=description)) + match.details["description"] = description + + if module.params.get("options") is not None and match.details.get("options") != options: + ops.append(dict(op="replace", path="{0}/{1}/options".format(path, match.index), value=options)) + match.details["options"] = options + + mso.sanitize(match.details) + + else: + + if not options: + mso.fail_json(msg=err_message_min_options) + + payload = {"name": option_policy, "options": options} + if description: + payload["description"] = description + + ops.append(dict(op="add", path="{0}/-".format(path), value=payload)) + + mso.sanitize(payload) + + mso.existing = mso.proposed + + elif state == "absent": + if match: + ops.append(dict(op="remove", path="{0}/{1}".format(path, match.index))) + mso.existing = {} + + if not module.check_mode and ops: + mso.request(mso_template.template_path, method="PATCH", data=ops) + + mso.exit_json() + + +def get_options_payload(options): + payload = [] + for option in options: + option_payload = {"name": option.get("name")} + if option.get("id") and id != 0: + option_payload["id"] = option.get("id") + if option.get("data"): + option_payload["data"] = option.get("data") + payload.append(option_payload) + return payload + + +if __name__ == "__main__": + main() diff --git a/tests/integration/targets/ndo_dhcp_option_policy/aliases b/tests/integration/targets/ndo_dhcp_option_policy/aliases new file mode 100644 index 00000000..5042c9c0 --- /dev/null +++ b/tests/integration/targets/ndo_dhcp_option_policy/aliases @@ -0,0 +1,2 @@ +# No ACI MultiSite infrastructure, so not enabled +# unsupported diff --git a/tests/integration/targets/ndo_dhcp_option_policy/tasks/main.yml b/tests/integration/targets/ndo_dhcp_option_policy/tasks/main.yml new file mode 100644 index 00000000..f472d0d0 --- /dev/null +++ b/tests/integration/targets/ndo_dhcp_option_policy/tasks/main.yml @@ -0,0 +1,351 @@ +# Test code for the MSO modules +# Copyright: (c) 2024, Akini Ross (@akinross) + +# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) + +- name: Test that we have an ACI MultiSite host, username and password + ansible.builtin.fail: + msg: 'Please define the following variables: mso_hostname, mso_username and mso_password.' + when: mso_hostname is not defined or mso_username is not defined or mso_password is not defined + +# CLEAN ENVIRONMENT +- name: Set vars + ansible.builtin.set_fact: + mso_info: &mso_info + host: '{{ mso_hostname }}' + username: '{{ mso_username }}' + password: '{{ mso_password }}' + validate_certs: '{{ mso_validate_certs | default(false) }}' + use_ssl: '{{ mso_use_ssl | default(true) }}' + use_proxy: '{{ mso_use_proxy | default(true) }}' + output_level: '{{ mso_output_level | default("info") }}' + +# QUERY VERSION +- name: Query MSO version + cisco.mso.mso_version: + <<: *mso_info + state: query + register: version + + +- name: Execute tasks only for MSO version > 4.3 + when: version.current.version is version('4.3', '>=') + block: + + - name: Ensure sites exists + cisco.mso.mso_site: + <<: *mso_info + site: '{{ item.site }}' + apic_username: '{{ apic_username }}' + apic_password: '{{ apic_password }}' + apic_site_id: '{{ item.apic_site_id }}' + urls: + - https://{{ apic_hostname }} + state: present + loop: + - {site: "ansible_test", apic_site_id: 101} + - {site: "ansible_test_2", apic_site_id: 102} + + - name: Ensure tenants exist + cisco.mso.mso_tenant: + <<: *mso_info + tenant: '{{ item }}' + users: + - '{{ mso_username }}' + sites: + - '{{ mso_site | default("ansible_test") }}' + - ansible_test_2 + state: present + loop: + - ansible_test + + - name: Ensure templates do not exist + cisco.mso.ndo_template: &template_absent + <<: *mso_info + name: ansible_tenant_template + template_type: tenant + tenant: ansible_test + state: absent + + - name: Ensure templates exist + cisco.mso.ndo_template: + <<: *template_absent + state: present + + # CREATE + + - name: Create a new dhcp option policy (check_mode) + cisco.mso.ndo_dhcp_option_policy: &create_dhcp_option_policy + <<: *mso_info + template: ansible_tenant_template + option_policy: ansible_test_option_policy + options: + - name: option_0 + id: 0 + data: data_0 + state: present + check_mode: true + register: cm_create_new_dhcp_option_policy + + - name: Create a new dhcp option policy + cisco.mso.ndo_dhcp_option_policy: + <<: *create_dhcp_option_policy + register: nm_create_new_dhcp_option_policy + + - name: Create a new dhcp option policy again + cisco.mso.ndo_dhcp_option_policy: + <<: *create_dhcp_option_policy + register: nm_create_new_dhcp_option_policy_again + + - name: Assert dhcp option policy was created + assert: + that: + - cm_create_new_dhcp_option_policy is changed + - cm_create_new_dhcp_option_policy.previous == {} + - cm_create_new_dhcp_option_policy.current.name == "ansible_test_option_policy" + - cm_create_new_dhcp_option_policy.current.options.0.name == "option_0" + - cm_create_new_dhcp_option_policy.current.options.0.data == "data_0" + - nm_create_new_dhcp_option_policy is changed + - nm_create_new_dhcp_option_policy.previous == {} + - nm_create_new_dhcp_option_policy.current.name == "ansible_test_option_policy" + - nm_create_new_dhcp_option_policy.current.options.0.name == "option_0" + - nm_create_new_dhcp_option_policy.current.options.0.data == "data_0" + - nm_create_new_dhcp_option_policy_again is not changed + - nm_create_new_dhcp_option_policy_again.previous.name == "ansible_test_option_policy" + - nm_create_new_dhcp_option_policy_again.previous.description == "" + - nm_create_new_dhcp_option_policy_again.previous.uuid is defined + - nm_create_new_dhcp_option_policy_again.previous.options.0.name == "option_0" + - nm_create_new_dhcp_option_policy_again.previous.options.0.data == "data_0" + - nm_create_new_dhcp_option_policy_again.current.name == "ansible_test_option_policy" + - nm_create_new_dhcp_option_policy_again.current.description == "" + - nm_create_new_dhcp_option_policy_again.current.uuid is defined + - nm_create_new_dhcp_option_policy_again.current.options.0.name == "option_0" + - nm_create_new_dhcp_option_policy_again.current.options.0.data == "data_0" + + # UPDATE + + - name: Update a dhcp option policy description (check_mode) + cisco.mso.ndo_dhcp_option_policy: &update_dhcp_option_policy + <<: *create_dhcp_option_policy + description: changed_description + check_mode: true + register: cm_update_dhcp_option_policy_description + + - name: Update a dhcp option policy description + cisco.mso.ndo_dhcp_option_policy: + <<: *update_dhcp_option_policy + register: nm_update_dhcp_option_policy_description + + - name: Update a dhcp option policy description again + cisco.mso.ndo_dhcp_option_policy: + <<: *update_dhcp_option_policy + register: nm_update_dhcp_option_policy_description_again + + - name: Assert dhcp option policy was updated + assert: + that: + - cm_update_dhcp_option_policy_description is changed + - cm_update_dhcp_option_policy_description.previous.description == "" + - cm_update_dhcp_option_policy_description.current.description == "changed_description" + - nm_update_dhcp_option_policy_description is changed + - nm_update_dhcp_option_policy_description.previous.description == "" + - nm_update_dhcp_option_policy_description.current.description == "changed_description" + - nm_update_dhcp_option_policy_description_again is not changed + - nm_update_dhcp_option_policy_description_again.previous.description == "changed_description" + - nm_update_dhcp_option_policy_description_again.current.description == "changed_description" + + - name: Update a dhcp option policy name + cisco.mso.ndo_dhcp_option_policy: &update_dhcp_option_policy_name + <<: *update_dhcp_option_policy + option_policy_uuid: '{{ nm_update_dhcp_option_policy_description.current.uuid }}' + option_policy: ansible_test_option_policy_changed + register: nm_update_dhcp_option_policy_name + + - name: Update a dhcp option policy options change input + cisco.mso.ndo_dhcp_option_policy: + <<: *update_dhcp_option_policy_name + options: + - name: option_1 + id: 1 + data: data_1 + register: nm_update_dhcp_option_policy_options_change_input + + - name: Update a dhcp option policy options to 4 + cisco.mso.ndo_dhcp_option_policy: &update_dhcp_option_policy_options_4 + <<: *update_dhcp_option_policy_name + options: + - name: option_1 + id: 1 + data: data_1 + - name: option_2 + id: 2 + data: data_2 + - name: option_3 + id: 3 + data: data_3 + - name: option_4 + id: 4 + register: nm_update_dhcp_option_policy_options_4 + + - name: Update a dhcp option policy options to 4 again + cisco.mso.ndo_dhcp_option_policy: + <<: *update_dhcp_option_policy_options_4 + register: nm_update_dhcp_option_policy_options_4_again + + - name: Update a dhcp option policy options order without change + cisco.mso.ndo_dhcp_option_policy: + <<: *update_dhcp_option_policy_name + options: + - name: option_1 + id: 1 + data: data_1 + - name: option_4 + id: 4 + - name: option_2 + id: 2 + data: data_2 + - name: option_3 + id: 3 + data: data_3 + register: nm_update_dhcp_option_policy_options_4_order + + - name: Delete a dhcp option policy option from the list + cisco.mso.ndo_dhcp_option_policy: + <<: *update_dhcp_option_policy_name + options: + - name: option_1 + id: 1 + data: data_1 + - name: option_3 + id: 3 + data: data_3 + - name: option_4 + id: 4 + register: nm_delete_dhcp_option_policy_options_3 + + - name: Assert dhcp option policy was updated + assert: + that: + - nm_update_dhcp_option_policy_name is changed + - nm_update_dhcp_option_policy_name.previous.name == "ansible_test_option_policy" + - nm_update_dhcp_option_policy_name.current.name == "ansible_test_option_policy_changed" + - nm_update_dhcp_option_policy_options_change_input is changed + - nm_update_dhcp_option_policy_options_change_input.previous.options | length == 1 + - nm_update_dhcp_option_policy_options_change_input.previous.options.0.name == "option_0" + - nm_update_dhcp_option_policy_options_change_input.current.options | length == 1 + - nm_update_dhcp_option_policy_options_change_input.current.options.0.name == "option_1" + - nm_update_dhcp_option_policy_options_4 is changed + - nm_update_dhcp_option_policy_options_4.previous.options | length == 1 + - nm_update_dhcp_option_policy_options_4.current.options | length == 4 + - nm_update_dhcp_option_policy_options_4_again is not changed + - nm_update_dhcp_option_policy_options_4_again.previous.options | length == 4 + - nm_update_dhcp_option_policy_options_4_again.current.options | length == 4 + - nm_update_dhcp_option_policy_options_4_order is changed + - nm_update_dhcp_option_policy_options_4_order.previous.options | length == 4 + - nm_update_dhcp_option_policy_options_4_order.current.options | length == 4 + - nm_delete_dhcp_option_policy_options_3 is changed + - nm_delete_dhcp_option_policy_options_3.previous.options | length == 4 + - nm_delete_dhcp_option_policy_options_3.current.options | length == 3 + + # QUERY + + - name: Create another dhcp option policy + cisco.mso.ndo_dhcp_option_policy: &create_dhcp_option_policy_2 + <<: *create_dhcp_option_policy + option_policy: ansible_test_option_policy_2 + description: "This is a test option policy 2" + + - name: Query a dhcp option policy with template_name + cisco.mso.ndo_dhcp_option_policy: + <<: *create_dhcp_option_policy_2 + state: query + register: query_one + + - name: Query all dhcp option policy in the template + cisco.mso.ndo_dhcp_option_policy: + <<: *mso_info + template: ansible_tenant_template + state: query + register: query_all + + - name: Assert dhcp option policy was queried + assert: + that: + - query_one is not changed + - query_one.current.name == "ansible_test_option_policy_2" + - query_all is not changed + - query_all.current | length == 2 + + # ERRORS + + - name: Error options provided as null on create + cisco.mso.ndo_dhcp_option_policy: &create_dhcp_option_policy_null_options + <<: *create_dhcp_option_policy + option_policy: ansible_test_option_policy_3 + options: '{{ fakevar | default(omit)}}' + register: err_options_create_null + ignore_errors: true + + - name: Error options provided as empty list on create + cisco.mso.ndo_dhcp_option_policy: + <<: *create_dhcp_option_policy_null_options + options: [] + register: err_options_create_empty_list + ignore_errors: true + + - name: Error no options provided on update + cisco.mso.ndo_dhcp_option_policy: + <<: *update_dhcp_option_policy_name + options: [] + register: err_options_update_empty_list + ignore_errors: true + + - name: Assert errors + assert: + that: + - err_options_create_null is failed + - err_options_create_null.msg == "At least one option is required when state is present." + - err_options_create_empty_list is failed + - err_options_create_empty_list.msg == "At least one option is required when state is present." + - err_options_update_empty_list is failed + - err_options_update_empty_list.msg == "At least one option is required when state is present." + + # DELETE + + - name: Delete a dhcp option policy (check_mode) + cisco.mso.ndo_dhcp_option_policy: &delete_dhcp_option_policy + <<: *update_dhcp_option_policy_name + state: absent + check_mode: true + register: cm_delete_dhcp_option_policy + + - name: Delete a dhcp option policy + cisco.mso.ndo_dhcp_option_policy: + <<: *delete_dhcp_option_policy + register: nm_delete_dhcp_option_policy + + - name: Delete a dhcp option policy again + cisco.mso.ndo_dhcp_option_policy: + <<: *delete_dhcp_option_policy + register: nm_delete_dhcp_option_policy_again + + - name: Assert dhcp option policy was deleted + assert: + that: + - cm_delete_dhcp_option_policy is changed + - cm_delete_dhcp_option_policy.previous.name == 'ansible_test_option_policy_changed' + - cm_delete_dhcp_option_policy.previous.options | length == 3 + - cm_delete_dhcp_option_policy.current == {} + - nm_delete_dhcp_option_policy is changed + - nm_delete_dhcp_option_policy.previous.name == 'ansible_test_option_policy_changed' + - nm_delete_dhcp_option_policy.previous.options | length == 3 + - nm_delete_dhcp_option_policy.current == {} + - nm_delete_dhcp_option_policy_again is not changed + - nm_delete_dhcp_option_policy_again.previous == {} + - nm_delete_dhcp_option_policy_again.current == {} + + # CLEANUP TEMPLATE + + - name: Ensure templates do not exist + cisco.mso.ndo_template: + <<: *template_absent