NetScaler Console service

Generate reports for load balancing entities

NetScaler Console allows you to view the reports of Citrix Application Delivery Controller (NetScaler) instance entities at all levels. There are two types of reports that you can download in NetScaler Console > Network Functions - consolidated reports and individual reports.

Consolidated reports: You can download and view a consolidated or a summarized report for all entities that are managed on NetScaler instances.

This report allows you to have a high-level view of the mapping between the NetScaler instances, partitions, and the corresponding load balancing entities (virtual servers, service groups, and services) that are present in the network.

The following image shows an example of a summarized report.

Generate report

The consolidated report is in a CSV format. The entries in each column are described as follows:

  • NetScaler IP Address: IP address of the NetScaler instance is displayed in the report
  • NetScaler HostName: Host name is displayed in the report.
  • Partition: IP address of the administrative partition is displayed
  • Virtual Server: <name_of_the_virtual_server>#virtual_IP_address­:port_number
  • Services: <name_of_the_service>#service-IP_address:port_number
  • Service Groups: <name_of_service_group>#server_member1_IP_address:port,server_member2_IP_address:port,server_member3_IP_address:port,………..,server_membern_IP_address:port


  • If there is no host name available, the corresponding IP address is displayed.
  • Blank columns indicate that the respective entities are not configured for that NetScaler instance.

Individual reports: You can also download and view independent reports of all instances and entities. For example, you can download a report for only load balancing virtual servers or load balancing services or load balancing service groups.

NetScaler Console allows you to download the report instantly. You can also schedule the report to be generated at a fixed time once a day, once a week, or once a month.

Generate a combined load balancing report

  1. In NetScaler Console, navigate to Infrastructure > Network Functions.

  2. Click Generate Report.

  3. On the Generate Report page that opens, you have two options to view the report:

    1. On the Export Now tab, select Load Balancing and click OK.

      The consolidated report downloads to your system.

    2. Select Schedule Report to create a schedule 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. Select Enable Schedule.

      2. Recurrence - select Daily, Weekly, or Monthly from the list.


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

        Schedule reports


        If you select Monthly recurrence, ensure that you enter days of month, with the values between 1 and 31.

      3. Export time - Enter the time in the Hour: Minute in 24-hour format.

      4. Email - check the check-box and then select a profile from the list, or click Add to create an email profile.

      5. Slack - Select the Slack check box and then select a profile from the list box, or click Add to create a slack profile.

      6. Click Schedule to complete the process.

Generate an individual load balancing entity report

You can generate and export an individual report for a particular type of entity associated with the instances. For example, consider a scenario where you want to see a list of all load balancing services in the network.

  1. In NetScaler Console, navigate to Infrastructure > Network Functions > Load Balancing > Services.

  2. On Services page, click the Export button at the top right-hand corner.

    Export reports

    Select Export Now tab if you want to generate and view the report at this instant.


    You can only download the reports or export the reports as mail attachments. You cannot view the reports on the NetScaler Console GUI.

Generate reports for load balancing entities