Application Delivery Management

Migrate Citrix ADC application configuration using StyleBooks Configuration Builder


This feature is in tech preview.

The StyleBooks Configuration Builder is used to create an application configuration StyleBook from an existing Citrix ADC configuration. This feature also automates the application configuration migration from one Citrix ADC instance to another instance.

Using Configuration Builder you can simplify the requirement to create a customized StyleBook. This feature enables you to create a StyleBook without in-depth knowledge of StyleBooks grammar and constructs. Otherwise, the knowledge of StyleBooks grammar and constructs is necessary to create a StyleBook.

The Configuration Builder also creates a ConfigPack that reflects the same ADC configuration on a new ADC instance. With this ConfigPack, the initial ADC configuration from one ADC instance can be duplicated to another ADC instance. The initial configuration source can be one of the following:

  • A Citrix ADC instance: Specify the instance where the application configuration that you want to duplicate is hosted.

    The Configuration Builder converts the ADC configuration to a StyleBook and ConfigPack even if you do not specify the target instance. You can later use this configpack to migrate the ADC configuration to other ADC instances.

  • A set of CLI Commands: Paste the configuration from ns.conf or Application config.

The Configuration Builder identifies the list of distinct applications embedded in the source configuration. When you select the application configuration of your interest, the Configuration Builder extracts the set of CLI commands for the selected application. These CLI commands are extracted from the source configuration. Also it identifies the deployment and configuration attributes that might require your input.

  • Deployment attributes - You can view and edit the IP address and port of the virtual servers, services, service group members from the original configuration.

  • Configuration attributes - These attributes can be passwords or certificates specified in the source configuration.

After specifying the necessary information, start migrating or duplicating the application configuration on a target ADC instance.

StyleBooks Configuration Builder workflow

After you complete application creation and migration, a ConfigPack is created in Citrix ADM along with its corresponding StyleBook. This ConfigPack represents the application configuration on the target ADC instance. To view the created ConfigPack, navigate to Applications > StyleBooks > Configurations.

Supported Citrix ADC Features

The StyleBook Configuration Builder recognizes and supports the following Citrix ADC features in the source configuration:

  • Content Switching
  • Load Balancing
  • Monitoring
  • SSL Offloading
  • Rate limiting
  • Rewrite
  • Responder
  • Web application firewall (WAF)

Create a StyleBook to migrate the Citrix ADC application configuration

The following procedure is to create a StyleBook that migrates the Citrix ADC application migration in Citrix ADM:

  1. Navigate to Applications > StyleBooks > Configurations.

  2. Click Migrate ADC Configuration.

  3. Click Get Started.

  4. In Specify Configuration, select the configuration source:

    • Import from an ADC: This option discovers the active applications on the selected ADC instance.

    • Import using CLI Commands: This option analyses the CLI commands and extracts the applications from the CLI commands.

  5. Specify the Source ADC Instance from which you want to migrate or duplicate the application configuration.

  6. Specify the Target ADC Instance to which you want to migrate or duplicate the application configuration.

  7. In Define Application,

    1. In Application Name, specify the name of the application.

    2. Select the virtual servers that you want to migrate.

    3. Click Next.

  8. In Equivalent CLI Commands, review the commands and click Next.

    These commands are specific to the selected application configuration.

  9. In Deployment Attributes, you can view and edit the IP address and port of the virtual servers, services, and service group members.

    To edit the IP address and port, click the edit icon on the virtual server, service, or service group member in the flow diagram.

    Edit the deployment attributes

    This tab appears only in the following cases:

    • The source and target instances are different.
    • Import configurations using CLI commands.
  10. In Configuration Attributes, specify the necessary details and click Next.

    This tab lists the secrets such as keys to decrypt passwords and certificates.


    Before you start the migration, the missed or unsupported configurations are displayed in any of the following tabs:

    Unsupported Configurations

    Unsupported Global Configurations

    To migrate these configurations successfully, you must apply the missed or unsupported configurations separately on the target instance. And, click Next.

  11. In Migrate, specify the required StyleBook details. Click Migrate.


  • The named expressions and responderhtmlpages mentioned in the source instance are not identified. Make sure to configure the named expressions and responderhtmlpages on the target instance before migration.

  • If the source has a configuration for servicegroup and monitor binding as follows:

    bind serviceGroup <Name> <Port> -monitorName <Monitor_Name>

    The following error appears:

     CLI Command conversion failed: 100 - No such command [{ "errorcode": 1090, "message": "No such argument [XXX]", "severity": "ERROR" }]

    This error occurs because Citrix ADC saves the binding between Service Group and Monitor in an invalid format. This issue is fixed from Citrix ADC build.

Migrate Citrix ADC application configuration using StyleBooks Configuration Builder