Merge branch 'main' into non_update

Author: shivashankar-vaddepally

.github/workflows/ah_token_refresh.yml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 jobs:
   refresh:
-    uses: ansible/team-devtools/.github/workflows/ah_token_refresh.yml@main
+    uses: ansible/ansible-content-actions/.github/workflows/refresh_ah_token.yaml@main
     with:
       environment: release
     secrets:

.github/workflows/test.yml

@@ -111,12 +111,12 @@ jobs:
     strategy:
       matrix:
         ansible:
-          - stable-2.15
+          - stable-2.17
         python-version:
           - 3.11
         netscaler-version:
-          - 13.1-49.15
-          - 14.1-4.42
+          - 13.1-58.20
+          - 14.1-47.29
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v4

CHANGELOG.md

@@ -7,9 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.9.0] - 2025-05-13
+
+### Added
+
+- Supported operation `apply`
+- Supported operation `rename`
+- Supported operation `install`([#487])
+
+### Fixed
+
+- Allowing system file to update contents([#496])
+
 ## [2.8.0] - 2025-02-18
 
 ### Added
+
 - Supported enable/disable for GSLB service operations([#452])
 
 ### Fixed
@@ -150,8 +163,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Initial Release
-
-[unreleased]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.8.0...HEAD
+[unreleased]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.9.0...HEAD
+[2.9.0]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.8.0...2.9.0
 [2.8.0]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.7.0...2.8.0
 [2.7.0]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.6.2...2.7.0
 [2.6.2]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.6.1...2.6.2

Makefile

@@ -39,7 +39,7 @@ build:
 	ansible-galaxy collection build --force
 
 galaxy_importer: build
-	python3 -m galaxy_importer.main netscaler-adc-2.8.0.tar.gz
+	python3 -m galaxy_importer.main netscaler-adc-2.9.0.tar.gz
 
 # build_docs:
 # 	rm -rf _built_docs

galaxy.yml

@@ -7,7 +7,7 @@ namespace: netscaler
 # The name of the collection. Has the same character restrictions as 'namespace'
 name: adc
 # The version of the collection. Must be compatible with semantic versioning
-version: 2.8.0
+version: 2.9.0
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md
 # A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)

plugins/module_utils/common.py

@@ -190,29 +190,47 @@ def _check_create_resource_params(resource_name, resource_module_params, action=
         ]
     except KeyError:
         resource_action_keys = []
-
-    # TODO: Should we allow non-add keys for the resource? OR should we error out if any non-add key is passed?
-    for key in resource_module_params.keys():
-        if not action:
-            if key in resource_add_keys:
-                post_data[key] = resource_module_params[key]
-            elif resource_name == "service" and key == "ipaddress":
-                post_data["ip"] = resource_module_params[key]
-            else:
-                log(
-                    "WARNING: Key `{}` is not allowed for the resource `{}` for CREATE operation. Skipping the key for the operation".format(
-                        key, resource_name
-                    )
-                )
+    if action == "rename":
+        oldnamekey = NITRO_RESOURCE_MAP[resource_name]["primary_key"]
+        if oldnamekey in resource_module_params:
+            post_data[oldnamekey] = resource_module_params[oldnamekey]
+        else:
+            msg = "ERROR: Key `{}` is required for the resource `{}` for RENAME operation".format(
+                oldnamekey, resource_name
+            )
+            log(msg)
+            return False, msg, None
+        if "newname" in resource_module_params:
+            post_data["newname"] = resource_module_params["newname"]
         else:
-            if key in resource_action_keys:
-                post_data[key] = resource_module_params[key]
+            msg = "ERROR: Key `newname` is required for the resource `{}` for RENAME operation".format(
+                resource_name
+            )
+            log(msg)
+            return False, msg, None
+    else:
+        # TODO: Should we allow non-add keys for the resource? OR should we error out if any non-add key is passed?
+        for key in resource_module_params.keys():
+            if not action:
+                if key in resource_add_keys:
+                    post_data[key] = resource_module_params[key]
+                elif resource_name == "service" and key == "ipaddress":
+                    post_data["ip"] = resource_module_params[key]
+                else:
+                    log(
+                        "WARNING: Key `{}` is not allowed for the resource `{}` for CREATE operation. Skipping the key for the operation".format(
+                            key, resource_name
+                        )
+                    )
             else:
-                log(
-                    "WARNING: Key `{}` is not allowed for the resource `{}` for `{}` action. Skipping the key for the operation".format(
-                        key, resource_name, action.upper()
+                if key in resource_action_keys:
+                    post_data[key] = resource_module_params[key]
+                else:
+                    log(
+                        "WARNING: Key `{}` is not allowed for the resource `{}` for `{}` action. Skipping the key for the operation".format(
+                            key, resource_name, action.upper()
+                        )
                     )
-                )
 
     return True, None, post_data
 
@@ -601,6 +619,10 @@ def get_valid_desired_states(resource_name):
         desired_states.add("switched")
     if "unset" in supported_operations:
         desired_states.add("unset")
+    if "Install" in supported_operations or "install" in supported_operations:
+        desired_states.add("installed")
+    if "rename" in supported_operations:
+        desired_states.add("renamed")
     if "apply" in supported_operations:
         desired_states.add("applied")
     return desired_states

plugins/module_utils/module_executor.py

@@ -44,6 +44,13 @@
 from .nitro_resource_map import NITRO_RESOURCE_MAP
 
 
+skippable_resource_list = [
+    # In some cases, although keys are listed as immutable in the nitro_resource_map, they can actually be updated.
+    # This list helps bypass the immutability check for these resources.
+    "sytemfile"
+]
+
+
 class ModuleExecutor(object):
     def __init__(self, resource_name, supports_check_mode=True):
         self.resource_name = resource_name
@@ -375,6 +382,14 @@ def is_resource_identical(self):
 
         return (False, None) if diff_list else (True, None)
 
+    @trace
+    def install(self):
+        ok, err = create_resource(
+            self.client, self.resource_name, self.resource_module_params
+        )
+        if not ok:
+            self.return_failure(err)
+
     @trace
     def create_or_update(self):
         self.update_diff_list(
@@ -463,7 +478,7 @@ def create_or_update(self):
                         self.client, self.resource_name, self.resource_module_params
                     )
 
-                elif immutable_keys_list is None:
+                elif immutable_keys_list is None or self.resource_name in skippable_resource_list:
                     self.module_result["changed"] = True
                     log(
                         "INFO: Resource %s:%s exists and is different. Will be UPDATED."
@@ -980,12 +995,16 @@ def main(self):
                 if "bindings" in NITRO_RESOURCE_MAP[self.resource_name].keys():
                     self.sync_all_bindings()
 
+            elif self.resource_name == "install" and self.module.params["state"] == "installed":
+                self.install()
+
             elif self.module.params["state"] in {
                 "created",
                 "imported",
                 "flushed",
                 "switched",
                 "unset",
+                "renamed",
                 "applied",
             }:
                 state_action_map = {
@@ -994,6 +1013,7 @@ def main(self):
                     "flushed": "flush",
                     "switched": "switch",
                     "unset": "unset",
+                    "renamed": "rename",
                     "applied": "apply",
                 }
                 self.act_on_resource(