Add support for Context Profiles and Service Groups #535

wstoneman · 2025-06-25T18:51:39Z

Add support to create/remove Context Profiles and Service Groups

Signed-off-by: William Stoneman [email protected]

Add support to create/remove Context Profiles and Service Groups Signed-off-by: William Stoneman <[email protected]>

Updated get_custom_attributes_from_display_name function for profiles with no attributes

ggverma · 2025-08-21T02:48:18Z

plugins/modules/nsxt_context_profile.py

+
+EXAMPLES = '''
+- name: Create a new Security Service
+  nsxt_security_services:


It seems like you used another module as a template. There are quite a few places that need to be updated to reflect the unique attrs of this module. For example, this should show nsxt_context_profiles.

Options and example updated.

ggverma · 2025-08-21T02:49:37Z

plugins/modules/nsxt_context_profile.py

+
+
+def main():
+    argument_spec = vmware_argument_spec()


Since this is an NSX Policy resource, you can use the template for nsxt_policy*.py modules. It removes a lot of boilerplate. Refer https://github.com/vmware/ansible-for-nsxt/blob/master/plugins/modules/nsxt_policy_ip_block.py or https://github.com/vmware/ansible-for-nsxt/blob/master/plugins/modules/nsxt_policy_segment.py

If you don't want to go that way, that's fine too

Based on timeframes for my project, we will utilize this approach. I will look into changing it for a future release.

ggverma · 2025-08-21T02:52:34Z

plugins/modules/nsxt_context_profile.py

+            if module.check_mode:
+                module.exit_json(changed=True, debug_out=str(json.dumps(context_params)), id='12345')
+
+            #print("?????????????????????????")


Left over testing. Removed.

ggverma · 2025-08-21T02:53:10Z

plugins/modules/nsxt_context_profile.py

+    manager_url = 'https://{}/policy/api/v1'.format(mgr_hostname)
+
+    # err_msg = 'NSX v9.0.0 and above do not support MP resources in nsxt_ip_blocks.py. Please use nsxt_policy_ip_block.py module.'
+    # validate_nsx_mp_support(module, manager_url, mgr_username, mgr_password, validate_certs, err_msg)


we can remove this, ruight?

ggverma · 2025-08-21T02:57:00Z

plugins/modules/nsxt_context_profile.py

+                                                       context_params['display_name'])
+    if existing_services is None:
+        return False
+    if existing_services['attributes'] != context_params['attributes']:


are you certain this op is fine? what if list size is not the same or it's a nested dict?

This has been tested. If the list of attributes differ it will "update" the profile.

same comment as in other module: the user may want to update other attrs

I took another look at it and updated the code to support display_name and description support. However, to allow this to work the end user needs to supply the ID. Otherwise there is no way to reference the object if they decide to update the display_name.

ggverma · 2025-08-21T02:58:23Z

plugins/modules/nsxt_context_profile.py

+                        }
+
+                        try:
+                            id = context_params['display_name'].replace(" ", "_")


afaik, id and display_name can be different. Other modules support that.

It can be difference, but if the display name follows proper naming standards (no spaces and use of "_") then the ID will be the same. This approach just simplifies the deployment and usage of the objects.

I think you don't have to specify the ID if display_name is present. If that's true, let server handle the behavior. Otherwise, you might end up creating a different behavior than the expectation

even worse, what if the user updates display_name? You'll end up using wrong ID and it could fail?

When creating the object you need to specify the ID in the URI. Having them the same simplifies the automation when calling the object in a different task.

If the end user updates the display_name later then it wont update the ID, this is definitely an issue with all nsxt objects.

I took another look at it and updated the code to support display_name and description support. However, to allow this to work the end user needs to supply the ID. Otherwise there is no way to reference the object if they decide to update the display_name.

Updated COntext Profile based on comments made on PR

ggverma · 2025-08-24T23:24:07Z

plugins/modules/nsxt_context_profile.py

+
+EXAMPLES = '''
+- name: Create a new Context Profile
+  nsxt_security_services:


nsxt_context_profile

ggverma · 2025-08-24T23:27:15Z

plugins/modules/nsxt_context_profile.py

+                        }
+
+                        try:
+                            id = context_params['display_name'].replace(" ", "_")


I think you don't have to specify the ID if display_name is present. If that's true, let server handle the behavior. Otherwise, you might end up creating a different behavior than the expectation

ggverma · 2025-08-24T23:29:02Z

plugins/modules/nsxt_security_services.py

+def get_services_from_display_name(module, manager_url, mgr_username, mgr_password, validate_certs, display_name):
+    services = get_services(module, manager_url, mgr_username, mgr_password, validate_certs)
+    for service in services['results']:
+        if service.__contains__('display_name') and service['display_name'] == display_name:


consider
if 'display_name' in service and ...

I took another look at it and updated the code to support display_name and description support. However, to allow this to work the end user needs to supply the ID. Otherwise there is no way to reference the object if they decide to update the display_name.

ggverma · 2025-08-24T23:30:10Z

plugins/modules/nsxt_security_services.py

+                                                       service_params['display_name'])
+    if existing_services is None:
+        return False
+    if existing_services['service_entries'] != service_params['service_entries']:


what if the user wants to update anything else like description or display name?

I took another look at it and updated the code to support display_name and description support. However, to allow this to work the end user needs to supply the ID. Otherwise there is no way to reference the object if they decide to update the display_name.

ggverma · 2025-08-24T23:32:27Z

plugins/modules/nsxt_context_profile.py

+                                                       context_params['display_name'])
+    if existing_services is None:
+        return False
+    if existing_services['attributes'] != context_params['attributes']:


same comment as in other module: the user may want to update other attrs

ggverma · 2025-08-24T23:33:09Z

plugins/modules/nsxt_context_profile.py

+                        }
+
+                        try:
+                            id = context_params['display_name'].replace(" ", "_")


even worse, what if the user updates display_name? You'll end up using wrong ID and it could fail?

Fixed update support to allow for display name and description update

wstoneman · 2025-08-27T17:27:00Z

I took another look at it and updated the code to support display_name and description support. However, to allow this to work the end user needs to supply the ID. Otherwise there is no way to reference the object if they decide to update the display_name.

wstoneman added 2 commits June 25, 2025 14:50

Add support for Context Profiles and Service Groups

2daf75c

Add support to create/remove Context Profiles and Service Groups Signed-off-by: William Stoneman <[email protected]>

Updated context profile module

9674256

Updated get_custom_attributes_from_display_name function for profiles with no attributes

ggverma reviewed Aug 21, 2025

View reviewed changes

Updated Context Profile

6fde48c

Updated COntext Profile based on comments made on PR

ggverma reviewed Aug 24, 2025

View reviewed changes

Updated modules to add update support

9b5274d

Fixed update support to allow for display name and description update

Add support for Context Profiles and Service Groups #535

Are you sure you want to change the base?

Add support for Context Profiles and Service Groups #535

Uh oh!

Conversation

wstoneman commented Jun 25, 2025

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!

Choose a reason for hiding this comment

Uh oh!

wstoneman Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

wstoneman commented Aug 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

wstoneman Aug 25, 2025 •

edited

Loading