ADC

Data governance

What is Citrix ADM service connect?

Citrix Application Delivery Management (ADM) service connect is a feature to enable seamless onboarding of Citrix ADC MPX, SDX, and VPX instances, and Citrix Gateway appliances onto Citrix ADM service. This feature lets the Citrix ADC instance or Citrix Gateway appliance automatically, securely connect with Citrix ADM service, and send system, usage, and telemetry data to it. Based on this data, you get insights and recommendations for your Citrix ADC infrastructure on Citrix ADM service.

By using the Citrix ADM service connect feature and onboarding your Citrix ADC instances or Citrix Gateway appliances to Citrix ADM service. You can also manage all your Citrix ADC and Citrix Gateway assets whether on-premises or in the cloud. In addition, you benefit from access to a rich set of visibility features that help in quick identification of performance issues, high resource usage, critical errors, and so on. Citrix ADM service provides a wide range of capabilities for your Citrix ADC instances and applications. For more information on Citrix ADM service, see Citrix Application Delivery Management Service

Important

  • Citrix Gateway appliance also supports the Citrix ADM service connect feature. For better ease, the Citrix Gateway appliance is not called explicitly in the consecutive sections.

  • Citrix ADM service connect feature is released for Citrix ADC MPX, SDX, and VPX instances, and Citrix Gateway appliances. However, the corresponding functionality on the Citrix ADM service is yet to go live. Citrix updates this note once it happens. The benefits of this new capability can be used once released on Citrix ADM service.

What is Citrix ADM service?

Citrix ADM service is a cloud-based solution that helps you manage, monitor, orchestrate, automate, and troubleshoot your Citrix ADC instances. It also provides you analytical insights and curated machine learning based recommendations about Citrix ADC instances and about application health, performance, and security. For more information, see Citrix ADM service Overview

How the Citrix ADM service connect is enabled?

Citrix ADM service connect is enabled by default, after you install or upgrade Citrix ADC or Gateway to release 12.1 build 57.xx and above.

What data is captured using Citrix ADM service connect?

The following details are captured using Citrix ADM service connect:

  • Citrix ADC details
    • Serial ID
    • Encoded Serial ID
    • Host ID
    • UUID
    • Management IP address
    • Host name
    • Version
    • Build type
    • Build
    • License type
    • Hypervisor
    • Deployment type(standalone/HA)
    • Platform type
    • Platform description
    • System ID
    • Modes enabled on ADC
    • Features enabled on ADC
  • License Information
    • Features licensed on Citrix ADC
    • License number
  • Key usage metrics
    • System date time
    • CPU usage percentage
    • Management CPU percentage
    • Throughput
    • SSL new sessions
    • SSL encryption throughput
    • SSL decryption throughput
    • System Uptime
  • Configuration
    • ns.conf file

    Note

    Before the Citrix ADM service connect sends the ns.conf file from Citrix ADC appliance to the Citrix ADM service, it anonymizes the encrypted or hashed passwords. The Citrix ADM service connect checks for “-encrypted” or “-passcrypt” parameters and replaces the associated encrypted or hashed value with ‘XXXX’. The Citrix ADM service connect then encodes and compresses the ns.conf file, and sends it to the Citrix ADM service endpoint.

  • Critical error details
    • Hard disk failures
    • SSL card failures
    • Power Supply Unit (PSU) failures
    • Flash drive failure
    • Warm reboot
    • Sustained memory usage above 90% or a memory leak
    • Sustained rate limit drops
  • Diagnostics details

    Note:

    The ADM diagnostic tool uses the following diagnostic details. For more information, see the Diagnostic tool topic in Citrix ADM.

    • ADC CLI status
    • ADC DNS status
    • network connection status to ADM endpoint “adm.cloud.com”
    • network connection status to ADM endpoint “agent.adm.cloud.com”
    • network connection status to ADM trust service “trust.citrixnetworkapi.net”
    • network connection status to ADM download site “download.citrixnetworkapi.net”

How the data is used?

By collecting the data, Citrix can provide you timely and in-depth insights about your Citrix ADC installations, which include the following:

  • Key metrics. Details of key metrics pertaining to CPU, memory, throughput, SSL throughput, and highlight anomalous behavior on Citrix ADC instances.
  • Critical errors. Any critical errors that might have occurred on your Citrix ADC instances.
  • Deployment advisory. Identify Citrix ADC instances that are deployed in standalone mode but have high throughput and are vulnerable to a single point of failure.
  • Diagnostic tool. When you onboard an ADC instance onto Citrix ADM, you might experience a few issues that prevent the ADC instance from successfully onboarding. To troubleshoot the issues, you can either manually use the diagnostic tool or see the diagnostic information in the ADM GUI. For more information, see Diagnostic tool.

How long the collected data is retained?

Any Data collected is retained for no longer than 13 months.

If you decide to terminate the use of the service by disabling the Citrix ADM service connect feature from the Citrix ADC, any previously collected data is deleted after a period of 30 days.

Where the data is stored and how secure is it?

All data collected by Citrix ADM service connect is stored in one of the three regions–United States, European Union, and Australia and New Zealand (ANZ). For more information, see Geographical Considerations.

The data is stored securely with strict tenant isolation at the database layer.

How to disable Citrix ADM service connect?

If you want to disable data collection through Citrix ADM service connect, see How to enable and disable Citrix ADM service connect.