Product Documentation

Citrix Gateway data source

If you have subscribed to Citrix Application Delivery Management (ADM) service that is offered on Citrix Cloud, Citrix Analytics automatically discovers the agents and Gateway instances added to ADM. You have to enable Analytics to allow Citrix Analytics to begin processing data for the Gateway instances.

If you are not subscribed to Citrix ADM or if you want to add additional Gateway data sources, you have to add them from the Analytics service.

This article walks you through the procedures to enable Analytics in both the scenarios.

Enable Analytics on Gateway data sources added to Citrix ADM

You must be subscribed to Citrix ADM. To learn how to get started with Citrix ADM, see Getting Started.

After signing in to Citrix Analytics, click Get Started on the Analytics Welcome page or navigate to Settings > Data Sources. Citrix Analytics automatically discovers the agents and the Citrix Gateway instances that are added to Citrix ADM.

Discovered agents are displayed as site cards on the Data Sources page. Click Enable Analytics and follow the prompts to allow Citrix Analytics to begin processing data for this data source. You can now start viewing processed data on the Analytics dashboards.

Data source page

Note: The Enable Analytics button is displayed only when the data source is discovered for the first time. However, you can turn on or off data processing anytime you want.

The status of the Citrix Gateway agent data source on the site card changes to Data Processing On.

Data source page

Turn on or turn off data processing

To turn off data processing, flip the site card and click Turn off data processing. This stops Citrix Analytics from processing data for this data source.

You can turn on data processing again by flipping the site card and clicking Turn on data processing.

Enable Analytics on Gateway data sources not added to Citrix ADM

If you are not subscribed to Citrix ADM or if you want to add additional Gateway data sources, add them from the Analytics service. This involves installing an agent, adding the instances, and enabling Analytics on virtual servers.

After signing in to Citrix Analytics, click Get Started on the Analytics Welcome page or navigate to Settings > Data Sources. From the Add On-Premises Data Sources tile, select Citrix Gateway.

Linked data sources select citrix gateway

Then, click Get Started.

Linked data sources select citrix gateway

Install and set up an agent

Install and configure the Citrix ADM service agent in your network environment to enable communication between Citrix Analytics and the instances in your data center.

You can install an agent on the following hypervisors in your enterprise data center:

  • Citrix Hypervisor

  • VMware ESXi

  • Microsoft Hyper-V

  • Linux KVM Server

To install and set up an agent, do the following:

  1. Download agent image.

    On the Set up agent on a hypervisor page, select the hypervisor and click Download Image to download the agent image to your local system.

    Select hypervisor

  2. Copy service URL and activation code.

    A service URL and an activation code are generated and displayed on the UI as shown in the image below. (This might take a few seconds.) The agent uses the service URL to locate the service and the activation code to register with the service. You have to enter the service URL and the activation code while installing the agent on your hypervisor.

    Copy Service URL and Activation Code

  3. Install the agent on a hypervisor.

    Note: Before you begin agent installation, ensure that:

    • You have the required virtual computing resources that the hypervisor must provide for each agent: RAM: 8 GB, vCPU:4, storage space: 120 GB, virtual network interface: 1, and throughput: 1 Gbps

    • You configure your DNS to allow internet access to your agent.

    • On Citrix hypervisor, perform the following:

      1. Import the agent image file to your hypervisor, and from the Console tab configure the initial network configuration options as shown in the following example.

        Agent network configuration

        If you have entered incorrect values or want to change any value, log on to the shell prompt by using the default credentials nsrecover/nsroot, and then run the command networkconfig.

      2. Enter the Service URL and the Activation Code that you saved when you had downloaded the agent image.

        Paste Service URL and Activation Code

        If you entered the service URL or the activation code incorrectly, log on to the shell prompt of the agent and then run the script: deployment_type.py. This script lets you reenter the Service URL and activation code.

    • On VMware ESXi hypervisor, perform the following:

      1. Import the agent image file to your hypervisor, and from the Console tab configure the initial network configuration options as shown in the following example.

        Agent network configuration

      2. After you configure the network, when prompted, log on to the shell prompt of the agent using the default credentials nsrecover/nsroot.

        Login

      3. Navigate to /mps directory, run the script deployment_type.py and enter the Service URL and the Activation Code that you saved when you had downloaded the agent image.

        Paste Service URL and Activation Code

    Note: You can use the same image file to install multiple agents. However, you cannot use the same activation code on more than one agent. To generate a new activation code, access Citrix Analytics, and on the Set up agent on a hypervisor step, click Download Image Again. A new activation code is generated.

  4. Register Agent.

    After agent registration is successful, the agent restarts to complete the installation process. After the agent has restarted, access Citrix Analytics and click Register Agent, and then verify the status of the agent.

    Verify Agent Registration

    When the agent status is in the UP state denoted by a green dot next to it, click Next to start adding instances to the service.

Add Citrix Gateway instances

Instances are Citrix Gateway appliances or virtual appliances that are the data sources for Citrix Analytics.

  1. On the Add Citrix Gateway Instances page, select the instance type and specify hostnames or IP Addresses or range of IP addresses of Gateway instances to discover.

  2. Create an authentication profile that the agent can use to access the Gateway instances. This profile is the administrator credentials of a Gateway instance. Then, click Add Instances.

    Add Instances

After the instances are added, you can view the number of instances that have been successfully discovered. To add more instances, click Add Citrix Gateway Instance.

Add Instances

Click Next to enable analytics.

Enable analytics

Citrix Analytics automatically discovers the licensed virtual servers on the added Citrix Gateway Instances. You must manually enable analytics on all the discovered virtual servers.

On the Enable Analytics page, by default, all the licensed virtual servers from the Gateway instances appear. Review the list of licensed virtual servers and click Enable Analytics to enable analytics on the virtual servers.

Enable analytics

A tile appears on the Data Sources page and the status of the site card changes to Data Processing On.

Enable analytics

Manage data source

You can turn off or turn on data processing anytime you want to. You can also add more instances to an agent or remove instances associated with an agent. You can also remove the agent and it’s associated instances from Citrix Analytics.

Flip an agent site card and do one of the following:

Enable analytics

  • Turn off data processing. This action stops Citrix Analytics from processing new data for your Citrix Gateway data sources. For details about data retention policy, see Data governance.

    To turn on data processing again, on the Data Sources page, flip an agent site card and click Turn on data processing. This will turn on data processing for the instances associated with that agent.

  • Add or Remove instances. You can add more Gateway instances to an agent and enable Analytics on the virtual servers configured on those instances. You can also remove instances added to an agent. When you dissociate an instance from an agent, Citrix Analytics cannot communicate with that instance.

  • Remove from Citrix Analytics. After you remove an agent site, Citrix Analytics stops collecting data from the instances associated with that agent, but all the previously processed data is available for the duration of the retention period.