Merge branch 'main' into NSNETAUTO_1005_bgprouter

Author: shivashankar-vaddepally

.gitignore

@@ -1,6 +1,5 @@
 .vscode/
 
-tools/
 issues/
 
 plugins/module_utils/test.ipynb

CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.10.0] - 2025-08-22
+
+### Added
+
+- Added migration tool to convert `citrix.adc` module playbooks to `netscaler.adc`.
+
+### Fixed 
+
+- Added option to skip non-updatable resources or fail explicitly
+- Removal of basic authentication from Netscaler ADC Ansible collection
+- Fixed idempotency issue in rename operations
+- Fixed GET request URL for global bindings to include type query parameter
+
 ## [2.9.2] - 2025-06-25
 
 ### Fixed 
@@ -177,7 +190,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.9.2...HEAD
+[unreleased]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.10.0...HEAD
+[2.10.0]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.9.2...2.10.0
 [2.9.2]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.9.1...2.9.2
 [2.9.1]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.9.0...2.9.1
 [2.9.0]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.8.0...2.9.0

Makefile

@@ -2,14 +2,17 @@ fmt:
 	autoflake plugins/modules/*.py
 	autoflake plugins/module_utils/*.py
 	autoflake --recursive tests/
+	autoflake migrationtool/*py
 
 	black plugins/modules/*.py
 	black plugins/module_utils/*.py
 	black tests/
+	black migrationtool/*.py
 
 	isort plugins/modules/*.py
 	isort plugins/module_utils/*.py
 	isort tests/
+	isort migrationtool/*.py
 
 	yamlfmt .
 
@@ -39,7 +42,7 @@ build:
 	ansible-galaxy collection build --force
 
 galaxy_importer: build
-	python3 -m galaxy_importer.main netscaler-adc-2.9.1.tar.gz
+	python3 -m galaxy_importer.main netscaler-adc-2.10.0.tar.gz
 
 # build_docs:
 # 	rm -rf _built_docs

README.md

@@ -157,6 +157,62 @@ export NETSCALER_NITRO_AUTH_TOKEN=$(curl -X POST -H "Content-Type:application/js
 echo $echo $NETSCALER_NITRO_AUTH_TOKEN
 ```
 
+### Migration Tool
+
+The collection includes a migration tool to help convert existing Ansible playbooks from the legacy `citrix.adc` collection to the new `netscaler.adc` collection format. This tool simplifies the transition from legacy automation to the updated collection.
+
+#### Features
+
+- **Module Mapping**: Automatically converts `citrix.adc` modules to `netscaler.adc` modules
+- **NITRO Request Conversion**: Transforms `citrix_adc_nitro_request` tasks to specific resource modules
+- **State Conversion**: Maps legacy operations (`add`, `update`, `delete`) to appropriate state values
+- **Credential Preservation**: Maintains authentication parameters and playbook structure
+- **YAML Structure Preservation**: Keeps task names, variables, and organization intact
+
+#### Usage
+
+```bash
+# Basic conversion
+python3 migrationtool/convert_yaml.py -i legacy_playbook.yaml -o migrated_playbook.yaml
+
+# With verbose output
+python3 migrationtool/convert_yaml.py -i legacy_playbook.yaml -o migrated_playbook.yaml -v
+```
+
+#### Example Conversion
+
+**Before (Legacy citrix.adc):**
+```yaml
+- name: Configure LB vserver
+  citrix_adc_nitro_request:
+    nsip: "{{ nsip }}"
+    nitro_user: "{{ nitro_user }}"
+    nitro_pass: "{{ nitro_pass }}"
+    operation: add
+    resource: lbvserver
+    name: my_lb_vserver
+    attributes:
+      servicetype: HTTP
+      ipv46: 10.10.10.10
+      port: 80
+```
+
+**After (New netscaler.adc):**
+```yaml
+- name: Configure LB vserver
+  netscaler.adc.lbvserver:
+    nsip: "{{ nsip }}"
+    nitro_user: "{{ nitro_user }}"
+    nitro_pass: "{{ nitro_pass }}"
+    state: present
+    name: my_lb_vserver
+    servicetype: HTTP
+    ipv46: 10.10.10.10
+    port: 80
+```
+
+For detailed migration tool documentation, usage examples, and troubleshooting, refer to the [Migration Tool README](https://github.com/netscaler/ansible-collection-netscaleradc/blob/main/migrationtool/README.md).
+
 ### Invocation
 
 The credentials of the netscaler can be provided either in the playbook by hardcoding or defining in a inventory.ini file.

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.9.2
+version: 2.10.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)
@@ -58,7 +58,6 @@ build_ignore:
   - ".DS_Store"
   - "docs"
   - "examples"
-  - "tools"
   - "issues"
   - "**/netscaler-adc-*.tar.gz"
   - "Makefile"

plugins/module_utils/common.py

@@ -14,6 +14,7 @@
     HTTP_RESOURCE_NOT_FOUND,
     HTTP_SUCCESS_CODES,
     NESTED_POST_DATA_RESOURCES,
+    GLOBAL_BINDING_ARG_LIST
 )
 from .decorators import trace
 from .logger import log
@@ -61,11 +62,21 @@ def get_resource(client, resource_name, resource_id=None, resource_module_params
 
     if resource_name.endswith("_binding"):
         # binding resources require `filter` instead of `args` to uniquely identify a resource
-        status_code, response_body = client.get(
-            resource=resource_name,
-            id=resource_id,
-            filter=get_args,
-        )
+        if resource_name in GLOBAL_BINDING_ARG_LIST:
+            # here we are making sure that for globalbindings present in the list query params args=type and filter=get_arg_keys
+            del get_args["type"]
+            status_code, response_body = client.get(
+                resource=resource_name,
+                id=resource_id,
+                filter=get_args,
+                args={"type": resource_module_params["type"]},
+            )
+        else:
+            status_code, response_body = client.get(
+                resource=resource_name,
+                id=resource_id,
+                filter=get_args,
+            )
     elif resource_name in {"sslcertfile"}:
         status_code, response_body = client.get(
             resource=resource_name,

plugins/module_utils/constants.py

@@ -116,3 +116,40 @@
         fallback=(env_fallback, ["MANAGED_NETSCALER_INSTANCE_PASSWORD"]),
     ),
 )
+
+# this list contains globalbindings whose GET call must have query params args=type and filter=get_arg_keys (check in nitro_resource_map)
+GLOBAL_BINDING_ARG_LIST = [
+    'dnsglobal_dnspolicy_binding',
+    'responderglobal_responderpolicy_binding',
+    'contentinspectionglobal_contentinspectionpolicy_binding',
+    'appflowglobal_appflowpolicy_binding',
+    'appfwglobal_auditnslogpolicy_binding',
+    'appfwglobal_auditsyslogpolicy_binding',
+    'appfwglobal_appfwpolicy_binding',
+    'rewriteglobal_rewritepolicy_binding',
+    'transformglobal_transformpolicy_binding',
+    'sslglobal_sslpolicy_binding',
+    'tunnelglobal_tunneltrafficpolicy_binding',
+    'cmpglobal_cmppolicy_binding',
+    'feoglobal_feopolicy_binding',
+    'icaglobal_icapolicy_binding',
+    'lbglobal_lbpolicy_binding',
+    'cacheglobal_cachepolicy_binding',
+    'botglobal_botpolicy_binding',
+]
+
+GETALL_ONLY_RESOURCES = [
+    'appfwlearningdata',
+    'application',
+    'bridgetable',
+    'gslbldnsentry',
+    'locationfile',
+    'locationfile6',
+    'routerdynamicrouting',
+    'sslcertbundle',
+    'sslcertfile',
+    'sslcrlfile',
+    'ssldhfile',
+    'sslkeyfile',
+    'systementitydata'
+]

plugins/module_utils/module_executor.py

@@ -39,6 +39,7 @@
     NETSCALER_COMMON_ARGUMENTS,
     NITRO_ATTRIBUTES_ALIASES,
     NESTED_POST_DATA_RESOURCES,
+    GETALL_ONLY_RESOURCES,
 )
 from .decorators import trace
 from .logger import log, loglines
@@ -322,17 +323,31 @@ def get_existing_resource(self):
         if is_exist is False:
             return {}
         if len(existing_resource) > 1:
-            msg = (
-                "ERROR: For resource `%s` Found more than one resource with the same primary key `%s` and resource_module_params %s"
-                % (
-                    self.resource_name,
-                    self.resource_id,
-                    self.resource_module_params,
+            if self.resource_name in GETALL_ONLY_RESOURCES:
+                for resources in existing_resource:
+                    # Check if all module params match this resource
+                    match_found = True
+                    for key, value in self.resource_module_params.items():
+                        if key in resources and resources[key] != value:
+                            match_found = False
+                            break
+
+                    # If all parameters match, use this resource
+                    if match_found:
+                        self.existing_resource = resources
+                        break
+            else:
+                msg = (
+                    "ERROR: For resource `%s` Found more than one resource with the same primary key `%s` and resource_module_params %s"
+                    % (
+                        self.resource_name,
+                        self.resource_id,
+                        self.resource_module_params,
+                    )
                 )
-            )
-            self.return_failure(msg)
-
-        self.existing_resource = existing_resource[0]
+                self.return_failure(msg)
+        else:
+            self.existing_resource = existing_resource[0]
 
         if self.resource_name in NITRO_ATTRIBUTES_ALIASES:
             self.existing_resource = self._add_nitro_attributes_aliases(