Product documentation
Citrix Application Delivery Management service
View PDF

Manage licensing and enable analytics on virtual servers

February 15, 2022
Contributed by: 
R R C

Note

By default, the Auto Licensed Virtual Servers option is enabled. You must ensure to have sufficient licenses to license the virtual servers. If you have limited licenses and want to license only the selective virtual servers based on your requirement, disable the Auto Licensed Virtual Servers option. Navigate to Settings > Licensing & Analytics Config and disable the Auto Licensed Virtual Servers option under Virtual Server License Allocation.

The process of enabling analytics is simplified. You can now license the virtual server and enable analytics in a single workflow.

Navigate to Settings > Licensing & Analytics Config to:

  • View the Virtual Server Licence Summary

  • View the Virtual Server Analytics Summary

    Subscription

When you click Configure License or Configure Analytics, the All Virtual Servers page is displayed.

Virtual server

On the All Virtual Servers page, you can:

  • Apply license for unlicensed virtual servers

  • Remove license for licensed virtual servers

  • Enable analytics on licensed virtual servers

  • Edit analytics

  • Disable analytics

    Note

    The supported virtual servers to enable analytics are Load Balancing, Content Switching, and Citrix Gateway.

Manage licensing on virtual servers

To license the virtual servers, from the All Virtual Servers page:

  1. Click the search bar, select Licensed, and select No.

    Licensed

    Unlicensed

    The filter is now applied and only the unlicensed virtual servers are displayed.

  2. Select the virtual servers and then click License.

    Apply license

To unlicense the virtual servers, from the All Virtual Servers page:

  1. Click the search bar, select Licensed, and select Yes.

    Licensed

    Licensed1

  2. Select the virtual servers and click Unlicense.

    Unlicense

Enable analytics

The following are the prerequisites to enable analytics for virtual servers:

  • Ensure that virtual servers are licensed

  • Ensure that analytics status is Disabled

  • Ensure that virtual servers are in UP status

You can filter the results to identify the virtual servers that are mentioned in the prerequisites.

  1. Click the search bar and select State and then select UP.

    Status

  2. Click the search bar and select Licensed, and then select Yes.

    Licensed

    Licensed1

  3. Click the search bar and select Analytics Status, and then select Disabled.

    Analytics status

  4. After applying the filters, select the virtual servers, and then click Enable Analytics.

    Enable analytics

  5. On the Enable Analytics window:

    1. Select the insight types (Web Insight, WAF Security Violations, Bot Security Violations)

    2. Select Logstream or IPFIX as Transport Mode

      Note

      For Citrix ADC 12.0 or earlier, IPFIX is the default option for Transport Mode. For Citrix ADC 12.0 or later, you can either select Logstream or IPFIX as Transport Mode.

      For more information about IPFIX and Logstream, see Logstream overview.

    3. The Expression is true by default

    4. Click OK

      Enable analytics

      Note

      • If you select virtual servers that are not licensed, then Citrix ADM first licenses those virtual servers and then enables analytics.

      • For admin partitions, only Web Insight is supported
      • For virtual servers such as Cache Redirection, Authentication, and GSLB, you cannot enable analytics. An error message is displayed.

After you click OK, Citrix ADM processes to enable analytics on the selected virtual servers.

Analytics process

Note

Citrix ADM uses Citrix ADC SNIP for Logstream and NSIP for IPFIX. If there is a firewall enabled between Citrix ADM agent and Citrix ADC instance, ensure you open the following port to enable Citrix ADM agent to collect AppFlow traffic:

Transport Mode Source IP Type Port
IPFIX NSIP UDP 4739
Logstream SNIP TCP 5557

Enable analytics for an instance

Alternatively, you can also enable analytics for a particular instance:

  1. Navigate to Infrastructure > Instances > Citrix ADC and then select the instance type. For example, VPX.

  2. Select the instance and from the Select Action list, select Configure Analytics.

    Configure-analytics

  3. On the Configure Analytics on Virtual Server(s) page, select the virtual server and click Enable Analytics.

    enable-analytics-vs

  4. On the Enable Analytics window:

    1. Select the insight type (Web Insight, WAF Security Violations, Bot Security Violations)

    2. Select Logstream or IPFIX as Transport Mode

      Note

      For Citrix ADC 12.0 or earlier, IPFIX is the default option for Transport Mode. For Citrix ADC 12.0 or later, you can either select Logstream or IPFIX as Transport Mode.

      For more information about IPFIX and Logstream, see Logstream overview.

    3. The Expression is true by default

    4. Click OK

Edit analytics

To edit analytics on the virtual servers:

  1. Select the virtual servers

  2. Click Edit Analytics

    Edit analytics

  3. Edit the parameters that you want to apply on the Edit Analytics Configuration window

  4. Click OK.

    Edit analytics config

Edit analytics for an instance

Alternatively, you can also disable analytics for a particular instance:

  1. Navigate to Network > Instance > Citrix ADC and the select the instance type. For example, VPX.

  2. Select the instance and click Edit Analytics

Disable analytics

To disable analytics on the selected virtual servers:

  1. Select the virtual servers

  2. Click Disable Analytics

    Disable analytics

Citrix ADM disables the analytics on the selected virtual servers

Disable analytics config

Manage licensing and enable analytics on virtual servers
February 15, 2022
Contributed by: 
R R C
February 15, 2022
Contributed by: 
R R C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings
© 1999- Citrix Systems, Inc. All rights reserved.