Product Documentation
Application Delivery Management
14.1 - Current Release 13.1 13.0
View PDF

Manage licensing and enable analytics on virtual servers

December 31, 2023
Contributed by: 
C

Note

  • The following information and procedure to enable analytics is applicable only if your Citrix ADM version is 13.0 build 41.x or later. If your Citrix ADM version is earlier than 13.0 build 36.27, then see enable analytics.

  • 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 Systems > Licensing & Analytics 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 System > Licensing & Analytics to:

  • View the Virtual Server Licence Summary

  • View the Virtual Server Analytics Summary

    license-summary

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

All-virtual-servers

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

    Licensed-no

    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.

    All Virtual Servers

    Select Yes to view licensed servers

  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 servers

    Set licensed server to yes

  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

    Note

    Alternatively, you can enable analytics for a particular instance:

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

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

    3. On the Configure Analytics on Virtual Servers page, select the Virtual Server and click Enable Analytics.

  5. On the Enable Analytics window:

    1. Select the insight types (Web Insight or Security Insight)

    2. Select Logstream 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. Under Instance level options:

      • Enable HTTP X-Forwarded-For - Select this option to identify the IP address for the connection between client and application, through HTTP proxy or load balancer.

      • Citrix Gateway - Select this option to view analytics for Citrix Gateway.

    4. The Expression is true by default

    5. Click OK

      Enabling 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.

Processing analytics

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 to collect AppFlow traffic:

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

Edit analytics

To edit analytics on the virtual servers:

  1. Select the virtual servers

    Note

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

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

    2. Select the instance and click Edit Analytics.

  2. Click Edit Analytics

    Edit analytics

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

  4. Click OK.

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 window

The following table describes the features of Citrix ADM that supports IPFIX and Logstream as the transport mode:

Feature IPFIX Logstream
Web Insight • •
Security Insight • •
Gateway Insight • •
HDX Insight • •
SSL Insight Not supported •
CR Insight • •
IP Reputation • •
AppFirewall • •
Client Side Measurement • •
Syslog/Auditlog • •

Enable analytics on virtual servers for earlier build

To enable analytics on virtual servers for Citrix ADM 13.0 build 36.27:

  1. Navigate to Networks > Instances > Citrix ADC, and select the Citrix ADC instance you want to enable analytics.

  2. From the list of instances, select an instance.

  3. From Select Action list, select Configure Analytics.

  4. In Application List, select the virtual servers and click Enable AppFlow.

  5. In the Enable AppFlow field, type true, and based on the analytics you want to enable, select Security Insight or Web Insight, or both.

    Enable-analytics

    Note

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

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

    • For HDX Insight and Gateway Insight, while clicking Enable AppFlow, you must select VPN virtual server configured on your Citrix ADC instance, and select the protocol ICA or HTTP check boxes accordingly.

      AppFlow

    • For TCP Insight, navigate to System > Analytics Settings > Configure Features, and select Enable TCP Insight.

    • For Video Insight, you must make the configuration changes on the Citrix ADC Appliance. For more details on how to enable analytics for Video insight, see Video Insight.

    • For WAN Insight:

      • Navigate to Infrastructure > Instances > Citrix SD-WAN WO, and select the data center WAN optimization appliance.

      • From the Action list, select Enable Insight.

      • Select the following parameters as required:

        • Geo data collection for HDX Insight: Shares client IP address with the Google Geo API.

        • AppFlow: Starts collecting data from WAN optimization instances.

          • TCP and WANOpt: Provides TCP and WANOpt Insight reports.

          • HDX: Provides HDX Insight reports.

          • TCP only for HDX: Provides TCP only for HDX Insight reports.

You can select the AppFlow transportation mode to IPFIX or Logstream while enabling AppFlow on the discovered Citrix ADC instances in Citrix ADM. For more information about IPFIX and Logstream, see Logstream overview.

The following table describes the features of Citrix ADM that supports IPFIX and Logstream as the transport mode:

Feature IPFIX Logstream
Web Insight • •
Security Insight • •
Gateway Insight • •
HDX Insight • •
SSL Insight Not supported •
CR Insight • •
IP Reputation • •
AppFirewall • •
Client Side Measurement • •
Syslog/Auditlog • •

You can also enable or disable the processing of the Web Insight traffic by using the Enable Web Insight option in Citrix ADM. If you do not want to monitor the Web Insight traffic, you can disable the option. Citrix ADM does not process the Web Insight traffic from the virtual servers on your managed instances.

Manage licensing and enable analytics on virtual servers
December 31, 2023
Contributed by: 
C
December 31, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.