Skip to content

README.md

Latest commit

 

History

History
167 lines (128 loc) · 4.57 KB

README.md

File metadata and controls

167 lines (128 loc) · 4.57 KB

NetScaler ADC Ansible Collection Migration Tool

This tool helps migrate existing Ansible playbooks from the legacy citrix.adc collection to the new netscaler.adc collection format.

Overview

The migration tool converts YAML playbooks that use:

  • Legacy citrix.adc modules
  • citrix_adc_nitro_request generic module

Into playbooks that use the new netscaler.adc collection modules.

Features

  • Module Mapping: Automatically maps legacy module names to new collection modules
  • State Conversion: Converts NITRO request operations to appropriate state values
  • Credential Handling: Preserves and converts authentication parameters
  • YAML Structure Preservation: Maintains playbook structure, variables, and task organization

Usage

Basic Usage

python3 convert_yaml.py -i input_playbook.yaml -o output_playbook.yaml

Arguments

  • -i, --input: (Required) Path to the input YAML playbook
  • -o, --output: (Optional) Path for the output file. Defaults to output.yaml
  • -v, --verbose: (Optional) Enable verbose mode

Example

python convert_yaml.py -i legacy_playbook.yml -o migrated_playbook.yml

Supported Conversions

Legacy Module Mappings

The tool uses resource_map to convert legacy module names to new collection modules:

  • 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:

Before:

- name: Configure LB vserver
  citrix_adc_nitro_request:
    nsip: "{{ nsip }}"
    nitro_user: "{{ nitro_user }}"
    nitro_pass: "{{ nitro_pass }}"
    operation: present
    resource: lbvserver
    name: my_lb_vserver
    attributes:
      servicetype: HTTP
      ipv46: 10.10.10.10
      port: 80

After:

- 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

Converts citrix.adc.<resource_name> to netscaler.adc.<resource_name> Before:

---
- 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:

- 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, update → present
  • delete → absent
  • action → Uses the action value from the task

Files

  • convert_yaml.py: Main conversion script
  • resourcelist.py: Contains resource_map and state_map mappings

Requirements

  • Python 3.x
  • PyYAML

Installation

pip install pyyaml

Input Format Support

The tool supports various YAML input formats:

  • Single playbook dictionary
  • List of tasks

Output

The tool generates a properly formatted YAML playbook with:

  • Converted module names
  • Preserved task names and structure
  • Proper indentation and formatting

Troubleshooting

Common Issues

  1. Resource not found: Check if the resource type exists in resource_map
  2. Missing name field: Ensure the original task has a name parameter for NITRO requests
  3. Authentication errors: Verify credential parameters are correctly set

Debug Output

The tool provides console output showing:

  • Module mappings being applied
  • NITRO request processing details
  • Tasks being converted

Contributing

To add support for new modules:

  1. Update resource_map in resourcelist.py
  2. Add appropriate state mappings if needed
  3. Test with sample playbooks

Support

As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the Create issue button on the top right corner. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, we strongly encourage engaging with the NetScaler and Ansible community. You can contribute to the collection or seek assistance via the NetScaler's Official GitHub Repository or connect with other Ansible users on the Ansible Forum.