Application Delivery Management


NetScaler Console service

Is NetScaler agent optional similar to on-premises NetScaler agent?

No. Agent is mandatory for NetScaler Console service and all communications between instances and NetScaler Console service happen through the agent. In NetScaler Console on-prem, agent is optional; however, you can configure an agent only for saving bandwidth consumption.

Why NetScaler Console service?

NetScaler Console service through Citrix Cloud provides the following benefits, without the need for new periodic builds:

  • Cloud-based SaaS offering with easier onboarding and lesser cost of ownership than the on-premises NetScaler Console.

  • Faster releases, approximately every two weeks with latest feature updates.

  • Machine-learning based analytics for application security, performance, and usage.

  • Various other features that are currently supported only in NetScaler Console service, such as peak and lean period analytics, machine-learning based application security analytics for WAF and bot, application CPU analytics, and many more.

You might also join the NetScaler Console service monthly webinar to understand the latest product features and solutions. Register for the webinar using the following link:

What happens after migration if on-premises NetScaler Console is an HA pair?

All configurations are moved to Citrix Cloud. Configuring a disaster recovery node is not required.

What happens if the agent goes down for any reason?

You can expect a potential data loss until the agent is up and running. However, you can also configure NetScaler agents for multisite deployments to ensure continuity if there is an agent failover. For more information, see Configure agents for multisite deployment.

Is instance backup also migrated?

Backup is not included in migration.

Is historical data also migrated?

Historical data is not migrated. You can export the data from the NetScaler Console on-prem.

Are on-prem licenses also migrated?

No. The on-prem license file cannot be used for NetScaler Console service. You must obtain licenses for NetScaler Console service. For more information, see Licensing. If you are using pooled licenses in NetScaler Console on-prem, you must obtain pooled licenses for NetScaler Console service and then allocate licenses to instances.

What is not migrated from on-premises NetScaler Console?

The following features cannot be migrated to NetScaler Console service:

  • RBAC – In NetScaler Console service, the user access is based on the invite from the administrator. NetScaler Console service users must have an account in Citrix Cloud. As a result, the NetScaler Console on-prem users are not migrated.

  • Export schedules – Export schedules include details such as drill-down and schedules from various pages. All these detailed export schedules are not migrated.

  • SSL Certificates/Keys/CSRs – NetScaler Console service can only display the NetScaler SSL certificates/Keys/CSRs. As a result, SSL certs/keys uploaded to on-premises NetScaler Console won’t be migrated to NetScaler Console service.

On-premises NetScaler Console is integrated with Citrix Director. What happens to the integration?

Director integration with NetScaler Console is currently supported only in NetScaler Console on-prem.

After migration, is it again required to license the instance or to enable analytics?

You must ensure that the licenses in NetScaler Console service are more than or equal to the on-premises VIP licenses. If the licenses are already more than the on-premises NetScaler Console VIP, the virtual servers are automatically licensed. If not, the licenses are assigned randomly.

Migration tool

After running the migration script, error messages are displayed. What can be the issue?

A log file with failure reasons is displayed. You can take appropriate corrective actions and run the migration script again. In general, before you run the migration script, ensure to:

  • Configure the NetScaler agent

  • Obtain the NetScaler Console service licenses

  • Copy the correct path where you have stored the client and secure CSV file

The NetScaler instances have lower versions than the mentioned limitation for pooled licensing. What happens if the option ‘Y’ is selected to change the license server?

Change of license server happens only for the supported NetScaler MPX, VPX, and SDX versions.

What happens if the migration script has failed configuration regarding NetScaler instances?

The NetScaler instances continue to work on the NetScaler Console on-prem setup. You can take necessary action from the suggested failed reason and run the migration script again.

What happens if a few of the NetScaler instances fail to move to NetScaler Console service. Will rerunning the migration script help?

Yes. After you rerun the script, only the failed instances are migrated. Let’s assume that two out of five instances have failed to move. After you have taken corrective actions and rerun the migration script, three instances that were moved successfully earlier show the “Device already exists” message. And the other two instances that failed earlier are migrated successfully.

Is there a log file to check the migration status?

Yes, a log file is generated in the /var/mps/log/ directory. NetScaler Console with python3.7 has the log file as and NetScaler Console with python 2.7 has the log file as

What happens if the session gets terminated while running the migration script?

You can rerun the migration script. In the new session, the already added instances from the last session display as “Device already exists”, and the migration continues further.

What happens if NetScaler Console service has lesser licenses than the on-premises NetScaler Console and the migration script is initiated?

After the migration script is run, a suggestion appears, mentioning about the licenses are lesser and prompts to continue or stop. If you want to continue with lesser licenses, the virtual servers are licensed randomly from the available licenses.

What happens when on-premises NetScaler Console is migrated to the NetScaler Console service Express Account?

The NetScaler Console service Express Account has only two virtual server licenses, two StyleBook config packs, and two configuration jobs. If your NetScaler Console on-prem has more than these configurations and you initiate the migration with Express Account, the script can migrate only the mentioned configurations applicable for Express Account (two virtual server licenses, two StyleBook config packs, and two configuration jobs)

What happens if a Citrix Cloud invited user (other than Admin User who created Citrix Cloud account) tries to migrate NetScaler Console on-prem setup?

It is recommended that the administrator to run the migration script. An invited user does not have admin privileges (adminExceptSystem_group). As a result, groups, roles, and policies migration fail and the message “User doesn’t have permission” is displayed.

As a solution, the administrator (who created the Citrix Cloud account) can change the group associated with invited user as “admin_group”.

Rollback script

What happens if rollback script is used in NetScaler Console on-prem HA pair?

The NetScaler Console on-prem HA pair is restored with all configurations that were available before migration.

What happens to Disaster Recovery node after using the rollback script?

Disaster recovery node is also restored with all configurations before migration.