[minor_change] Add module ndo_pod_profile for pod profiles in fabric resource templates (DCNE-141) #672

akinross · 2025-05-16T07:28:56Z

fixes #469

… policy templates

…settings delete

… macsec and ntp policies

…resource templates

… pod settings policy

sajagana

LGTM!

gmicol · 2025-05-19T17:51:04Z

plugins/modules/ndo_pod_profile.py

+- name: Create a Pod Profile
+  cisco.mso.ndo_pod_profile:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_test
+    name: ansible_pod_profile
+    pod_settings: ansible_pod_settings
+    state: present
+  register: create_pod_profile
+
+- name: Update a Pod Profile using name
+  cisco.mso.ndo_pod_profile:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_test
+    name: ansible_pod_profile
+    pod_settings: ansible_pod_settings
+    description: Updated Pod Profile
+    pods:
+      - 1
+      - 2
+    state: present
+
+- name: Update a Pod Profile using UUID
+  cisco.mso.ndo_pod_profile:
+    host: mso_host
+    username: admin
+    password: SomeSecretPassword
+    template: ansible_test
+    name: ansible_pod_profile_changed
+    uuid: "{{ create_pod_profile.current.uuid }}"
+    pod_settings_uuid: "{{ create_pod_settings.current.uuid }}"
+    state: present


Missing pod_settings_template (or pod_settings_template_id) as it is required with pod_settings (or pod_settings_uuid)

plugins/module_utils/template.py

shrsr · 2025-05-22T13:56:21Z

plugins/modules/ndo_pod_profile.py

+        if pods:
+            mso_values["blocks"] = pods
+            mso_values["kind"] = "podRange"
+        elif pods == []:


Since we're only changing the settings of pod from providing 'a range' to 'all' or 'all' to 'a range', shall we make it simple for the user by saying that if pods is not provided it is applied to all the pods every time (initial create and update)?

elif not pods: mso_values["kind"] = "all"

this is for the update case to be set correct where we do not want to change when not provided, only on the create the we force it to all when not provided

I know this is for the update case. I was thinking should we make the behaviour consistent for both create and update where if pods is not provided means the profile is applied to all.
Let's skip this if unnecessary..

ok i thought we would never update anything that was not provided?

plugins/modules/ndo_pod_profile.py

shrsr · 2025-05-22T14:00:49Z

plugins/modules/ndo_pod_profile.py

+    mso.exit_json()
+
+
+def set_pod_profile_policy_names(mso, mso_templates, pod_profile):


This function is really useful for policy objects that are not supported by the API yet. Can we make it generic?
It will be useful for future modules to consume this function.

For now I chose to include in the module since I did not want to change existing function. Shall we create a separate issue to track this feature?

Yes, let's open another issue then

sajagana · 2025-05-23T11:15:32Z

plugins/modules/ndo_pod_profile.py

+            mso_values["kind"] = "all"
+
+        pod_settings_mso_template = mso_templates.get_template("fabric_policy", pod_settings_template, pod_settings_template_id)
+        mso_values["policy"] = pod_settings_mso_template.get_pod_settings_object(pod_settings_uuid, pod_settings, fail_module=True).details.get("uuid")


Can we ignore the pod settings object lookup when the "pod_settings_uuid" is provided by the user?

sure will remove

…t ndo handle error

samiib · 2025-05-27T04:22:56Z

plugins/module_utils/template.py

+            search_object = self.template
+        existing_objects = search_object.get("fabricPolicyTemplate", {}).get("template", {}).get("podPolicyGroups", [])
+        if uuid or name:  # Query a specific object
+            return self.get_object_by_key_value_pairs("Pod Settings", existing_objects, [KVPair("uuid", uuid) if uuid else KVPair("name", name)], fail_module)


Should this be the plural Pod Settings or singular Pod Setting.

The UI names it in plural form and so does the template, so I would say it would be in plural form. If you think this should be done differently let me know.

samiib · 2025-05-27T04:29:25Z

plugins/modules/ndo_pod_profile.py

+    type: list
+    elements: int
+    aliases: [ blocks ]
+  pod_settings:


We have previously been nesting this reference objects into dictionaries.
ie.

pod_settings: dictionary { name: str, required, template: str, template_id: str } pod_settings_uuid: str

Have we decided to format specs without nesting now?

I do not know all the constant changes that have decided but if you can provide me this then I can change. I thought at least it was like this in the past that for required attributes we would flatten the structure, because the user input would be easier.

samiib · 2025-05-27T04:39:59Z

plugins/modules/ndo_pod_settings.py

+    description:
+    - The description of the Pod Settings.
+    type: str
+  macsec_policy:


Should macsec_policy and ntp_policy be in a dictionary with a name option? This would be consistent with other modules.

If this is agreed upon by the team I can change, but do not see the value of nesting a single value since there is also not template selection. The user input would always be:

macsec_policy: name_or_uuid: value

Instead of just:

macsec_policy_name_or_uuid: value

samiib · 2025-05-27T04:43:43Z

plugins/modules/ndo_pod_profile.py

+                    pod_settings_template = mso_templates.get_template("fabric_policy", template.get("templateName"), template.get("templateId"))
+                    match = pod_settings_template.get_pod_settings_object(pod_settings_uuid)
+                    if match:
+                        pod_profile["policyName"] = match.details.get("name")


Should the pod settings templateId and templateName be added?

samiib · 2025-05-27T04:45:57Z

plugins/modules/ndo_pod_profile.py

+    mso.exit_json()
+
+
+def set_pod_profile_policy_names(mso, mso_templates, pod_profile):


Should this function also be adding the templateName/templateId of the pod profile?

akinross added 3 commits May 14, 2025 14:50

[minor_change] Add module ndo_pod_settings for pod settings in fabric…

6f14cc6

… policy templates

[ignore] remove unused schemas and templates objects

fe2b792

[ignore[ remove redundant space character from test assertion of pod …

af5e23e

…settings delete

akinross requested review from anvitha-jain, gmicol, lhercot, sajagana, samiib and shrsr as code owners May 16, 2025 07:28

github-actions bot changed the title ~~[minor_change] Add module ndo_pod_profile for pod settings in fabric resource templates~~ [minor_change] Add module ndo_pod_profile for pod settings in fabric resource templates (DCNE-141) May 16, 2025

akinross changed the title ~~[minor_change] Add module ndo_pod_profile for pod settings in fabric resource templates (DCNE-141)~~ [minor_change] Add module ndo_pod_profile for pod profiles in fabric resource templates (DCNE-141) May 19, 2025

[ignore] change response value to be non existing camel case name for…

ada32cb

… macsec and ntp policies

akinross force-pushed the 469_pod_profile_module branch 3 times, most recently from 58a768d to 0938241 Compare May 19, 2025 08:17

akinross added 2 commits May 19, 2025 10:27

[minor_change] Add module ndo_pod_profile for pod profiles in fabric …

6abf7ef

…resource templates

[ignore] change response value to be non existing camel case name for…

d40a58f

… pod settings policy

akinross force-pushed the 469_pod_profile_module branch from 0938241 to d40a58f Compare May 19, 2025 08:27

sajagana previously approved these changes May 19, 2025

View reviewed changes

gmicol requested changes May 19, 2025

View reviewed changes

akinross dismissed sajagana’s stale review via 80f6db0 May 19, 2025 18:01

akinross requested review from gmicol and sajagana May 19, 2025 18:05

shrsr requested changes May 22, 2025

View reviewed changes

akinross requested a review from shrsr May 23, 2025 07:05

sajagana requested changes May 23, 2025

View reviewed changes

akinross force-pushed the 469_pod_profile_module branch from 80f6db0 to bea7de4 Compare May 23, 2025 13:34

akinross requested a review from sajagana May 23, 2025 13:35

akinross force-pushed the 469_pod_profile_module branch from bea7de4 to 73703af Compare May 23, 2025 13:37

[ignore] only retrieve uuid when not provided for pod_settings and le…

7238c53

…t ndo handle error

akinross force-pushed the 469_pod_profile_module branch from 73703af to 7238c53 Compare May 23, 2025 13:39

samiib requested changes May 27, 2025

View reviewed changes

		mso.exit_json()


		def set_pod_profile_policy_names(mso, mso_templates, pod_profile):

[minor_change] Add module ndo_pod_profile for pod profiles in fabric resource templates (DCNE-141) #672

Are you sure you want to change the base?

[minor_change] Add module ndo_pod_profile for pod profiles in fabric resource templates (DCNE-141) #672

Uh oh!

Conversation

akinross commented May 16, 2025

Uh oh!

sajagana left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!