Added NetFlow Exporter and Monitor tenant policy modules (DCNE-368 DCNE-369)

plugins/module_utils/mso.py

@@ -2118,3 +2118,40 @@ def epg_object_reference_spec(aliases=None):
     if aliases:
         epg_reference_spec["aliases"] = aliases
     return epg_reference_spec
+
+
+def ndo_template_object_spec_with_uuid(aliases=None, required_uuid_or_reference=True):
+    ndo_template_object_spec_with_uuid = dict(
+        options=dict(
+            uuid=dict(type="str"),
+            reference=dict(
+                type="dict",
+                aliases=["ref"],
+                options=dict(
+                    name=dict(type="str", required=True),
+                    template=dict(type="str"),
+                    template_id=dict(type="str"),
+                ),
+                required_one_of=[
+                    ["template", "template_id"],
+                ],
+                mutually_exclusive=[
+                    ("template", "template_id"),
+                ],
+            ),
+        ),
+        required_one_of=[
+            ["reference", "uuid"],
+        ],
+        mutually_exclusive=[
+            ("reference", "uuid"),
+        ],
+    )
+
+    if not required_uuid_or_reference:
+        ndo_template_object_spec_with_uuid.pop("required_one_of")
+
+    if aliases:
+        ndo_template_object_spec_with_uuid["aliases"] = aliases
+
+    return ndo_template_object_spec_with_uuid

plugins/module_utils/template.py

@@ -1433,3 +1433,41 @@ def get_netflow_record(self, uuid=None, name=None, search_object=None, fail_modu
         if uuid or name:  # Query a specific object
             return self.get_object_by_key_value_pairs("NetFlow Record", match, [KVPair("uuid", uuid) if uuid else KVPair("name", name)], fail_module)
         return match  # Query all objects
+
+    def get_netflow_exporter(self, uuid=None, name=None, search_object=None, fail_module=False):
+        """
+        Get the NetFlow Exporter by uuid or name.
+        :param uuid: UUID of the NetFlow Exporter to search for -> Str
+        :param name: Name of the NetFlow Exporter to search for -> Str
+        :param search_object: The object to search in -> Dict
+        :param fail_module: When match is not found fail the ansible module -> Bool
+        :return: Dict | None | List[Dict] | List[]: The processed result which could be:
+                 When the UUID | Name is existing in the search list -> Dict
+                 When the UUID | Name is not existing in the search list -> None
+                 When both UUID and Name are None, and the search list is not empty -> List[Dict]
+                 When both UUID and Name are None, and the search list is empty -> List[]
+        """
+        search_object = search_object if search_object else self.template
+        match = search_object.get("tenantPolicyTemplate", {}).get("template", {}).get("netFlowExporters", [])
+        if uuid or name:  # Query a specific object
+            return self.get_object_by_key_value_pairs("NetFlow Exporter", match, [KVPair("uuid", uuid) if uuid else KVPair("name", name)], fail_module)
+        return match  # Query all objects
+
+    def get_netflow_monitor(self, uuid=None, name=None, search_object=None, fail_module=False):
+        """
+        Get the NetFlow Monitor by uuid or name.
+        :param uuid: UUID of the NetFlow Monitor to search for -> Str
+        :param name: Name of the NetFlow Monitor to search for -> Str
+        :param search_object: The object to search in -> Dict
+        :param fail_module: When match is not found fail the ansible module -> Bool
+        :return: Dict | None | List[Dict] | List[]: The processed result which could be:
+                 When the UUID | Name is existing in the search list -> Dict
+                 When the UUID | Name is not existing in the search list -> None
+                 When both UUID and Name are None, and the search list is not empty -> List[Dict]
+                 When both UUID and Name are None, and the search list is empty -> List[]
+        """
+        search_object = search_object if search_object else self.template
+        match = search_object.get("tenantPolicyTemplate", {}).get("template", {}).get("netFlowMonitors", [])
+        if uuid or name:  # Query a specific object
+            return self.get_object_by_key_value_pairs("NetFlow Monitor", match, [KVPair("uuid", uuid) if uuid else KVPair("name", name)], fail_module)
+        return match  # Query all objects

plugins/modules/ndo_tenant_netflow_exporter.py

@@ -0,0 +1,218 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2026, Sabari Jaganathan (@sajagana) <sajagana@cisco.com>
+
+# 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_tenant_netflow_exporter
+version_added: "2.12.0"
+short_description: Manage NetFlow Exporter on Cisco Nexus Dashboard Orchestrator (NDO).
+description:
+- Manage NetFlow Exporter on Cisco Nexus Dashboard Orchestrator (NDO).
+- This module is only supported on ND v4.1 and later.
+author:
+- Sabari Jaganathan (@sajagana)
+options:
+  template:
+    description:
+    - The name of the template.
+    - The template must be a tenant template.
+    - This parameter or O(template_id) is required.
+    type: str
+  template_id:
+    description:
+    - The ID of the tenant template.
+    - This parameter or O(template) is required.
+    type: str
+  name:
+    description:
+    - The name of the NetFlow Exporter.
+    type: str
+  uuid:
+    description:
+    - The UUID of the NetFlow Exporter.
+    - This parameter is required when the O(name) needs to be updated.
+    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
+notes:
+- The O(template) must exist before using this module in your playbook.
+  Use M(cisco.mso.ndo_template) to create the Tenant template.
+seealso:
+- module: cisco.mso.ndo_template
+extends_documentation_fragment: cisco.mso.modules
+"""
+
+EXAMPLES = r"""
+- name: Add a NetFlow Exporter
+  cisco.mso.ndo_tenant_netflow_exporter:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_tenant_template
+    name: netflow_exporter_1
+    state: present
+  register: add_netflow_exporter
+
+- name: Update a NetFlow Exporter name using UUID
+  cisco.mso.ndo_tenant_netflow_exporter:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_tenant_template
+    name: netflow_exporter_1_updated
+    uuid: "{{ add_netflow_exporter.current.uuid }}"
+    state: present
+
+- name: Query a NetFlow Exporter using name
+  cisco.mso.ndo_tenant_netflow_exporter:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_tenant_template
+    name: netflow_exporter_1_updated
+    state: query
+  register: query_one_with_name
+
+- name: Query a NetFlow Exporter using UUID
+  cisco.mso.ndo_tenant_netflow_exporter:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_tenant_template
+    uuid: "{{ add_netflow_exporter.current.uuid }}"
+    state: query
+  register: query_one_with_uuid
+
+- name: Query all NetFlow Exporters
+  cisco.mso.ndo_tenant_netflow_exporter:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_tenant_template
+    state: query
+  register: query_all
+
+- name: Remove a NetFlow Exporter using name
+  cisco.mso.ndo_tenant_netflow_exporter:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_tenant_template
+    name: netflow_exporter_1_updated
+    state: absent
+
+- name: Remove a NetFlow Exporter using UUID
+  cisco.mso.ndo_tenant_netflow_exporter:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_tenant_template
+    uuid: "{{ add_netflow_exporter.current.uuid }}"
+    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.templates import MSOTemplates
+from ansible_collections.cisco.mso.plugins.module_utils.utils import append_update_ops_data
+
+
+def main():
+    argument_spec = mso_argument_spec()
+    argument_spec.update(
+        template=dict(type="str"),
+        template_id=dict(type="str"),
+        name=dict(type="str"),
+        uuid=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", ["name", "uuid"], True],
+            ["state", "present", ["name", "uuid"], True],
+        ],
+        required_one_of=[
+            ["template", "template_id"],
+        ],
+    )
+
+    mso = MSOModule(module)
+    mso_templates = MSOTemplates(mso)
+
+    template_name = mso.params.get("template")
+    template_id = mso.params.get("template_id")
+    name = mso.params.get("name")
+    uuid = mso.params.get("uuid")
+    state = mso.params.get("state")
+
+    ops = []
+    match = None
+    path = None
+
+    mso_template = mso_templates.get_template("tenant", template_name, template_id)
+    mso_template.validate_template("tenantPolicy")
+
+    match = mso_template.get_netflow_exporter(uuid, name)
+    if (uuid or name) and match:  # Query a specific object
+        mso.existing = mso.previous = copy.deepcopy(mso_template.update_config_with_template_and_references(match.details))
+    elif match:  # Query all objects
+        mso.existing = [mso_template.update_config_with_template_and_references(obj) for obj in match]
+
+    if state != "query":
+        path = "/tenantPolicyTemplate/template/netFlowExporters/{0}".format(match.index if match else "-")
+
+    if state == "present":
+        mso_values = {
+            "name": name,
+        }
+        if match:
+            append_update_ops_data(ops, match.details, path, mso_values)
+            mso.sanitize(mso_values, collate=True)
+        else:
+            mso.sanitize(mso_values)
+            ops.append(dict(op="add", path=path, value=mso.sent))
+
+    elif state == "absent" and match:
+        ops.append(dict(op="remove", path=path))
+
+    mso_template.update_config_with_template_and_references(mso.proposed, set_template=mso.proposed != {})
+
+    if not module.check_mode and ops:
+        response = mso.request(mso_template.template_path, method="PATCH", data=ops)
+        match = mso_template.get_netflow_exporter(uuid, name, response)
+        if match:
+            mso.existing = mso_template.update_config_with_template_and_references(match.details)  # When the state is present
+        else:
+            mso.existing = {}  # When the state is absent
+    elif module.check_mode and state != "query":  # When the state is present/absent with check mode
+        mso.existing = mso.proposed if state == "present" else {}
+
+    mso.exit_json()
+
+
+if __name__ == "__main__":
+    main()