NetScaler Console service


How many agents do I need to install?

The number of agents depends on the number of managed instances in a data center and the total throughput. Citrix recommends that you install at least one agent for every data center.

How can I install multiple agents?

You can install only one agent when you log on to the service for the first time. To add multiple agents, first complete the initial setup, and then navigate to Settings > Setup Agents.

Does NetScaler agent support AMD processors?


Can I transition from a built-in agent to an external agent?

Yes, you can. For more information, see Transition from a built-in agent to an external agent.

How do I get a new activation code if I lose it?

If you are onboarding for the first time, access the service GUI, navigate to the Set Up Agent screen, and click Generate Activation Code.

While trying to install a second agent, to generate a new activation code, navigate to Infrastructure > Instances > Agents > Generate Activation Code.

How do I log on to the agent VM? What are the default credentials?

If your agent is installed on a hypervisor or Microsoft Azure cloud, the default logon credentials for the agent are nsrecover/nsroot, which opens the shell prompt of the agent.

If your agent is installed on AWS, the default credentials to log on to the agent is nsrecover/instance id.

What are the resource requirements to install an agent on a hypervisor on-premises?

32 GB RAM, 8 Virtual CPU, 500 GB Storage, 1 Virtual Network Interfaces, 1 Gbps Throughput

Do I need to assign an extra disk to the agent while provisioning?

No, you do not have to add an extra disk. The agent is used only as an intermediary between the NetScaler Console and the instances in your enterprise data center or on the cloud. It does not store inventory or analytics data that would require an extra disk.

Can I reuse my activation code with multiple agents?

No, you cannot.

How do I rerun network settings if I have entered an incorrect value?

Access the agent console on your hypervisor, log on to the shell prompt by using the credentials nsrecover/nsroot, and then run the command networkconfig.

What do I do if my agent registration fails?

Ensure that:

  • Your agent has access to the Internet (configure DNS).

  • You have copied the activation code correctly.

  • You have entered the service URL correctly.

  • You have the required ports open.

Registration is successful, but how do I know if the agent is running fine?

After the agent is successfully registered, access NetScaler Console and navigate to the Set Up Agent screen. You can see the discovered agent on the screen. If the agent is running fine, a green icon appears. If it is not running, a red icon appears.

How can I connect agents to NetScaler Console using a proxy server?

You can connect agents to NetScaler Console using a proxy server. The script is available at /mps folder in agent. The agents forward all their data to the proxy server, which then sends the data to the NetScaler Console through the internet.

To forward data using the proxy server, type the proxy server details on the agent using the following script:, and follow the instructions provided by the script to enter more information. The agent fetches this information while it connects to NetScaler Console using the proxy server.

You can authenticate your proxy server by providing your user name and password information. When the agent sends the data, the proxy server authenticates the user credentials before forwarding it to NetScaler Console.

For more information, see NetScaler Console as an API proxy server.


NetScaler Console supports proxy servers with basic authentication enabled. NetScaler Console also supports proxy servers where authentication is disabled.

I do not see my Analytics Reports

Enable insight on your virtual servers to see the Analytics Reports. For details, see Enabling Analytics.

Which versions of NetScaler instances are supported in NetScaler Console?

For management and monitoring features, NetScaler instances running 10.5 and later are supported. Some features are only supported on certain NetScaler versions. For details, see System Requirements.

How do I export dashboard reports in NetScaler Console?

To export the report of any dashboard in NetScaler Console, click the Export icon on the top right side of this page. On the Export page, you can do one of the following:

  1. Select Export Now tab. To view and save the report in PDF, JPEG, PNG, or CSV format. The report downloads to your system.

  2. Select Schedule Report to set up schedules for generating and exporting reports at regular intervals. Specify the report generation recurrence settings and create an email profile to which the report is exported.

    1. Recurrence - Select Daily, Weekly, or Monthly from the drop-down list box.


      • If you select Weekly recurrence, ensure that you select the weekdays on which you want the report to be scheduled.

      • If you select Monthly recurrence, ensure that you enter all the days that you want the report to be scheduled separated by commas.

    2. Recurrence time - Enter the time as Hour: Minute in 24-hour format.

    3. Email - Select the check box and then select the profile from the drop-down list box, or click Add to create an email profile.

    4. Slack - Select the check box and then select the profile from the drop-down list box, or click Add to create an email profile.

    Click Enable Schedule to schedule your report and then, click OK. By clicking the Enable Schedule check box, you can generate the selected reports.

What does enabling client-side measurements do?

With client side measurements enabled, NetScaler Console captures load time and render time metrics for HTML pages, through HTML injection. Using these metrics, admins can identify L7 latency issues.

Is SSL traffic from Agent to NetScaler Console service taken through SSL inspection?

We recommend you to bypass the SSL inspection for Agent to the NetScaler Console service SSL traffic.