Managing subscriptions

Citrix Application Delivery Management (Citrix ADM) requires a verified license to manage and monitor Citrix ADC instances, Citrix Gateway instances, and third party load balancers.

You can manage and monitor any number of instances when you are on the trial period or when you have subscribed to a valid license. However, you can manage the discovered applications on the App Dashboard, view analytics data, and monitor network functions and network reports only for the number of virtual servers for which you have purchased licenses. During trial period, you can monitor only ten virtual servers or applications.

With each installed license, you receive a limited amount of data and capacity to manage certain virtual servers. However, you can also purchase and apply data-only licenses to top up your data storage.

Note

After the trial period expires, you must purchase a valid license to continue to use any feature in Citrix ADM.

For information and instructions about buying and upgrading your Citrix ADM licenses, see https://www.citrix.com/products/citrix-cloud/subscriptions.html.

The following table lists the Citrix licenses that are required to use some of the Citrix ADM features.

Citrix ADM Feature Group Citrix ADM Features Citrix ADC and Gateway License Requirement
Analytics HDX Insight Advanced (reporting < 1 hour) Premium (reporting = Unlimited)
Analytics Security Insight Premium (or) Advanced with App Firewall license
Analytics Gateway Insight Advanced (reporting < 1 hour) Premium (reporting = Unlimited)
Applications Application Statistics (App Dashboard, App Security Dashboard) Citrix Web App Firewall related information on App dashboard, and app security dashboard needs Premium (or) Advanced with App Firewall license
Applications Stylebooks N/A
Applications Inventory Management – Infrastructure Dashboard, Instance groups, Instance dashboards & Sites N/A
Applications Event Management & Syslog N/A
Applications Configuration Jobs, Configuration Audit, and Configuration Advice N/A
Applications Network reporting (Instance level) N/A
Applications Network reporting (virtual server level) N/A
Applications Network Functions (Plain visibility & Management of virtual servers, services, service groups, server) N/A
Applications SSL certificate management (Instance level) N/A
Applications SSL certificate management (virtual server level) N/A
System RBAC & External Authentication (instance level) N/A
System RBAC & External Authentication (virtual server level) N/A

View the subscription details

You can view the licenses installed on your Citrix ADM by navigating to AccountSubscriptions. You can also view the license summary such as the type of license subscribed to, the entitled data subscription and consumed data subscription, and the allowed and managed virtual servers and third party virtual servers in the Subscription Summary section.

localized image

Manage subscriptions for third-party virtual servers

You can manage and monitor any number of HAProxy hosts when you are on the trial period or when you have subscribed to a valid license. However, you can manage the discovered applications on the HAProxy App Dashboard, view analytics data, and monitor network functions only for the number of third party virtual servers for which you have purchased licenses. During trial period, you can monitor only ten third party virtual servers or applications.

Note

In this document, the third-party virtual server refers to the HAProxy frontend.

Manage virtual servers

You can select the virtual servers or third party virtual servers you want to manage and monitor through Citrix ADM.

Points to note:

  • By default, Citrix ADM automatically licenses the virtual servers randomly after each virtual server poll cycle.

  • If the total number of virtual servers discovered in your Citrix ADM is lower than the number of installed virtual server licenses, Citrix ADM, by default, licenses all the virtual servers.

To select the virtual servers manually, or to restrict licensing to limited virtual servers, you have to first disable auto licensing the virtual servers, and then select the virtual servers you want to manage.

To disable auto-licensing virtual servers:

  1. Navigate to Settings > Subscriptions.

    The dashboard displays the virtual server licenses available, the managed virtual servers along with the virtual server type, and license expiry information.

  2. In Virtual Server License Summary, disable Auto-select Virtual Servers.

    localized image

To select third party virtual servers for licensing:

  1. Navigate to Settings > Subscriptions.

    The dashboard displays the virtual server licenses available, the managed virtual servers along with the virtual server type, and license expiry information.

  2. In Third Party Virtual Server Summary, disable Auto-select Third Party Virtual Servers.

    localized image

Apply license and enable analytics

The process of licensing virtual servers and then enabling analytics on the licensed virtual servers has been simplified. Earlier, to enable analytics for any virtual server, you must navigate to Networks > Instances > Citrix ADC, and then select the virtual server to enable analytics. If virtual servers are not licensed for an instance:

  • You need to first license the virtual servers by navigating to Account > Subscriptions

  • Then, again navigate to Networks > Instances > Citrix ADC to enable analytics for the virtual servers

Citrix ADM now eliminates this dual process, and enables you to license virtual servers and apply analytics in a single workflow. Navigate to Account > Subscriptions to:

  • View the Virtual Server Licence Summary

  • View the Virtual Server Analytics Summary

    localized image

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

localized image

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.

    localized image

    localized image

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

  1. Select the virtual servers and then click License.

    localized image

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

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

    localized image

    localized image

  2. Select the virtual servers and click Unlicense.

    localized image

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.

    localized image

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

    localized image

    localized image

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

    localized image

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

    localized image

  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 Transaport Mode. For Citrix ADC 12.0 or later, you can either select Logstream or IPFIX as Transport Mode.

    3. The Expression is true by default

    4. Click OK

      localized image

      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.

localized image

Edit analytics

To edit analytics on the virtual servers:

  1. Select the virtual servers

  2. Click Edit Analytics

    localized image

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

  4. Click OK.

    localized image

Disable analytics

To disable analytics on the selected virtual servers:

  1. Select the virtual servers

  2. Click Disable Analytics

    localized image

Citrix ADM disables the analytics on the selected virtual servers

localized image

View the licensed virtual servers

After the licenses are applied to the virtual servers, you can view the licensed virtual servers or third-party virtual servers from the Subscriptions page. To view the licensed virtual servers, navigate to Settings > Subscriptions and click the virtual server type in the Total Licensed section in the Virtual Servers License Summary.

localized image

Configure auto license support for non-addressable virtual servers

Citrix ADM, by default, does not automatically apply licenses to non-addressable virtual servers. For licensing non-addressable virtual servers, you must disable the auto-license option and manually select the non-addressable virtual servers. This increases your effort to manually select the non-addressable servers initially when you apply the licenses. You also need to manually select the new non-addressable virtual servers whenever they are added to your network.

Citrix ADM provides an option in Citrix ADM under Virtual Server License Summary. That is, the new option Auto-select nonaddressable Virtual Servers. Enabling this option now allows you to explicitly specify that the licensing should include non-addressable virtual servers also.

localized image

Note

  • Citrix ADM, by default, still does not auto select non-addressable virtual servers for licensing.

  • Application analytics (App Dashboard) is the only analytics supported currently on licensed non-addressable virtual servers.

View expiry checks for virtual server subscriptions

You can view the status of installed licenses with the expiry and the allowed storage limit to the licenses in Citrix ADM.

To view the status of the licenses:

  1. Navigate to Account > Subscriptions.

  2. In the Entitlements section, you can view the details of licensed virtual servers and the days to expiry:

    • Entitled Virtual Servers: Number of virtual server available to license.

    • Entitled Third Party Virtual Servers: Number of third party virtual servers you can manage with the license.

    • Entitled Storage: Storage limit of the license.

    • Days to Expiry: Number of days remaining before the license expiry.

      localized image

View the type of analytics enabled on the virtual servers

After you enable AppFlow on the selected virtual servers, you can view the type of analytics enabled on the licensed virtual servers or third-party virtual servers from the Subscriptions page.

  1. Navigate to Account > Subscriptions.

  2. In the Virtual Server Analytics Summary section, select the type of licensed virtual servers.

    localized image

  3. The licensed virtual servers page displays the list of licensed virtual servers. On this page, the Analytics Status column displays the type of analytics enabled on the virtual servers.

    localized image