Merge branch 'main' into shivashankar-vaddepally-patch-1

Author: shivashankar-vaddepally

.gitignore

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

CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.10.1] - 2025-09-16
+
+# Fixed 
+
+- Resolved error while importing new SSL certificate with duplicate primary key error
+
+## [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 +196,10 @@ 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.1...HEAD
+[2.10.1]: https://github.com/netscaler/ansible-collection-netscaleradc/compare/2.10.0...2.10.1
+[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,16 +2,19 @@ fmt:
 	autoflake plugins/modules/*.py
 	autoflake plugins/module_utils/*.py
 	autoflake --recursive tests/
+	autoflake tools/migrationtool/*.py
 
 	black plugins/modules/*.py
 	black plugins/module_utils/*.py
 	black tests/
+	black tools/migrationtool/*.py
 
 	isort plugins/modules/*.py
 	isort plugins/module_utils/*.py
 	isort tests/
+	isort tools/migrationtool/*.py
 
-	yamlfmt .
+	yamlfmt $(shell find . -name '*.yml' -o -name '*.yaml')
 
 install:
 	ansible-galaxy collection install . --force
@@ -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.1.tar.gz
 
 # build_docs:
 # 	rm -rf _built_docs
@@ -60,7 +63,7 @@ galaxy_importer: build
 # skip the playbook which contains "password" in the file name
 run_examples:
 	@for playbook in examples/*.yaml; do \
-		if [[ $$playbook == *"password"* || $$playbook == *"login"* || $$playbook == *"logout"* || $$playbook == *"route"* || $$playbook == locationfile.yaml || $$playbook == nsip6.yaml || $$playbook == hanode.yaml ]]; then \
+		if [[ $$playbook == *"password"* || $$playbook == *"login"* || $$playbook == *"logout"* || $$playbook == *"route"* || $$playbook == *"locationfile.yaml"* || $$playbook == *"nsip6.yaml"* || $$playbook == *"hanode.yaml"* ]]; then \
 			continue; \
 		fi; \
 		echo "Running $$playbook"; \

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/tools/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.

examples/bgprouter.yaml

@@ -0,0 +1,32 @@
+---
+- name: Sample bgprouter playbook
+  hosts: localhost
+  gather_facts: false
+  tasks:
+    - name: Configure bgprouter
+      delegate_to: localhost
+      netscaler.adc.bgprouter:
+        state: present
+
+        localAS: 122
+        routerId: "2.2.2.2"
+        afParams:
+          - addressFamily: "ipv4"
+            redistribute:
+              - protocol: "static"
+                routeMap: "test"
+          - addressFamily: "ipv6"
+        neighbor:
+          - address: "44.1.1.33"
+            remoteAS: 300
+            ASOriginationInterval: 11
+            advertisementInterval: 34
+            updateSource: "vlan101"
+            singlehopBfd: false
+            multihopBfd: false
+            afParams:
+              - addressFamily: "ipv4"
+                routeMap:
+                  - name: "test"
+                    direction: "out"
+              - addressFamily: "ipv6"

examples/sslhsmkey.yaml

@@ -0,0 +1,13 @@
+---
+- name: Create ssl hsm key
+  hosts: localhost
+  gather_facts: false
+  tasks:
+    - name: Create ssl hsm key
+      delegate_to: localhost
+      netscaler.adc.sslhsmkey:
+        state: present
+        hsmkeyname: "hsmk1"
+        hsmtype: "SAFENET"
+        serialnum: "116877xxxx465464"
+        password: "xxxxxxx"

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.1
 # 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"

meta/runtime.yml

@@ -981,3 +981,4 @@ action_groups:
     - sslechconfig.py
     - sslhpkekey.py
     - sslprofile_sslechconfig_binding.py
+    - bgprouter

plugins/module_utils/client.py

@@ -15,7 +15,11 @@
 from ansible.module_utils.six.moves.urllib.parse import quote
 from ansible.module_utils.urls import fetch_url
 
-from .constants import HTTP_SUCCESS_CODES
+from .constants import (
+    DYNAMIC_PROTOCOLS,
+    DYNAMIC_PROTOCOLS_ALIAS,
+    HTTP_SUCCESS_CODES,
+)
 from .decorators import trace
 from .logger import log
 
@@ -62,25 +66,25 @@ def __init__(self, module, resource_name):
         )
         if netscaler_console_as_proxy:
             if self._module.params.get("managed_netscaler_instance_name"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_NAME"
-                ] = self._module.params.get("managed_netscaler_instance_name")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_NAME"] = (
+                    self._module.params.get("managed_netscaler_instance_name")
+                )
             if self._module.params.get("managed_netscaler_instance_ip"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_IP"
-                ] = self._module.params.get("managed_netscaler_instance_ip")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_IP"] = (
+                    self._module.params.get("managed_netscaler_instance_ip")
+                )
             if self._module.params.get("managed_netscaler_instance_id"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_ID"
-                ] = self._module.params.get("managed_netscaler_instance_id")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_ID"] = (
+                    self._module.params.get("managed_netscaler_instance_id")
+                )
             if self._module.params.get("managed_netscaler_instance_username"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_USERNAME"
-                ] = self._module.params.get("managed_netscaler_instance_username")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_USERNAME"] = (
+                    self._module.params.get("managed_netscaler_instance_username")
+                )
             if self._module.params.get("managed_netscaler_instance_password"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_PASSWORD"
-                ] = self._module.params.get("managed_netscaler_instance_password")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_PASSWORD"] = (
+                    self._module.params.get("managed_netscaler_instance_password")
+                )
 
     @trace
     def url_builder(
@@ -98,6 +102,9 @@ def url_builder(
         filter = filter if filter is not None else {}
 
         # Construct basic URL
+        if resource in DYNAMIC_PROTOCOLS:
+            resource = "routerDynamicRouting/" + DYNAMIC_PROTOCOLS_ALIAS[resource]
+
         url = "%s://%s/%s/%s" % (
             self._module.params["nitro_protocol"],
             self._module.params["nsip"],
@@ -235,6 +242,7 @@ def post(self, post_data, resource, action=None):
     def put(self, put_data, resource=None, id=None):
         url = self.url_builder(resource, id=id)
         data = self._module.jsonify(put_data)
+
         return self.send("PUT", url, data)
 
     @trace