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

Manage licensing and enable analytics on virtual servers

April 29, 2024
Contributed by: 
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 Configuration and disable the Auto Licensed Virtual Servers option under Virtual Server License Allocation.

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

Navigate to Settings > Licensing & Analytics Configuration 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 NetScaler 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-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.

  2. Select the virtual servers and click 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.

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

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

  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 Infrastructure > Instances > NetScaler 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 WAF Security Violations)

    2. Select Logstream as Transport Mode

      Note

      For NetScaler 12.0 or earlier, IPFIX is the default option for Transport Mode. For NetScaler 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.

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

    4. The Expression is true by default

    5. Click OK

      Enabling analytics

      Note

      • If you select virtual servers that are not licensed, then NetScaler Console 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, NetScaler Console processes to enable analytics on the selected virtual servers.

Note

NetScaler Console uses NetScaler SNIP for Logstream and NSIP for IPFIX. If there is a firewall enabled between NetScaler agent and NetScaler instance, ensure you open the following port to enable NetScaler Console 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 Infrastructure > Instances > NetScaler and then select the instance type. For example, VPX.

    2. Select the instance and click Edit Analytics.

  2. Click 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

NetScaler Console disables the analytics on the selected virtual servers

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

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

Configure analytics globally

Apart from the existing process to enable analytics, you can also use a single-pane workflow to configure analytics on:

  • All the existing licensed virtual servers

  • The subsequent licensed virtual servers

After configuration, this feature eliminates the necessity to manually enable analytics on the existing and subsequent virtual servers.

Points to note:

Before you configure analytics, you must understand the following behaviors of NetScaler Console:

  • When you configure this feature for the first time, you must ensure that the prerequisites mentioned in this document are met.

  • Modify the analytics settings later.

    Consider that you have configured the analytics settings for the first time by selecting Web Insight, HDX Insight, and Gateway Insight. If you want to modify the analytics settings later and deselect Gateway Insight, the changes do not impact the virtual servers that are already enabled with analytics.

  • The virtual servers that are already enabled with analytics.

    Consider that you have 10 licensed virtual servers and two of them are already enabled with analytics. In this scenario, this feature enables analytics only for the remaining eight virtual servers.

  • The virtual servers that are manually disabled with analytics.

    Consider that you have 10 licensed virtual servers and you have manually disabled analytics for two virtual servers. In this scenario, this feature enables analytics only for the remaining eight virtual servers and skips the virtual servers that are manually disabled with analytics.

  • Bot Security Violations and WAF Security Violations options are supported only in premium licensed virtual servers. If the virtual servers are not premium licensed, then Bot Security Violations and WAF Security Violations are not enabled.

Prerequisites

Ensure that:

  • All existing virtual servers are licensed.

  • Auto-licensed option is enabled to license all the subsequent virtual servers. Navigate to Settings > Licensing & Analytics Config and under Virtual Server License Allocation, turn on the Auto Licensed Virtual Servers option.

Enable analytics

  1. Navigate to Settings > Licensing & Analytics Config.

  2. Under Analytics Summary, click Global Analytics Configuration.

    Global analytics configuration

  3. Select the analytics features that you want to enable analytics on the virtual servers.

  4. To enable analytics on the subsequent virtual servers, select the Apply this analytics settings on the subsequent licensed virtual servers check box.

  5. Click Submit.

    Analytics configuration

Manage licensing and enable analytics on virtual servers
April 29, 2024
Contributed by: 
R C
April 29, 2024
Contributed by: 
R 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.