Merge pull request #545 from netscaler/migration_tool_NSNETAUTO-1024

Migration tool nsnetauto 1024

Author: shivashankar-vaddepally

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 .
 

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.

migrationtool/README.md

@@ -41,8 +41,9 @@ python convert_yaml.py -i legacy_playbook.yml -o migrated_playbook.yml
 
 ### Legacy Module Mappings
 The tool uses `resource_map` to convert legacy module names to new collection modules:
-- `citrix.adc.lbvserver` → `netscaler.adc.lbvserver`
-- `lbvserver` → `netscaler.adc.lbvserver`
+- `citrix.adc.<resource_name>` → `netscaler.adc.<resource_name>`
+- `<resource_name>` → `netscaler.adc.<resource_name>`
+- `citrix_adc_nitro_request` → `netscaler.adc.<resource_name>`
 
 ### NITRO Request Conversion
 Converts `citrix_adc_nitro_request` tasks to specific resource modules:
@@ -77,12 +78,38 @@ Converts `citrix_adc_nitro_request` tasks to specific resource modules:
     port: 80
 ```
 
+Converts `citrix.adc.<resource_name>` to `netscaler.adc.<resource_name>`
+**Before:**
+```yaml
+---
+- name: create server
+    delegate_to: localhost
+    citrix_adc_nitro_request:
+    operation: add
+    resource: server
+    name: test-server-1
+    attributes:
+        name: test-server-1
+        ipaddress: 10.10.10.10
+```
+
+**After:**
+```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
+```
+
 ### State Mapping
-- `add` → `present`
-- `update` → `present`
+- `add`, `update` → `present`
 - `delete` → `absent`
-- `present` → `present`
-- `absent` → `absent`
 - `action` → Uses the action value from the task
 
 ## Files
@@ -104,14 +131,12 @@ pip install pyyaml
 
 The tool supports various YAML input formats:
 - Single playbook dictionary
-- List of plays
-- List of tasks (automatically wrapped in a play structure)
+- List of tasks
 
 ## Output
 
 The tool generates a properly formatted YAML playbook with:
 - Converted module names
-- Updated authentication parameters  
 - Preserved task names and structure
 - Proper indentation and formatting