Initiate built-in agent on the Citrix ADC instance

January 21, 2020

Contributed by: R C

Citrix ADC instances running release 12.0 build 56.20 and later include a Citrix ADM built-in agent. Instead of installing a dedicated agent in your data center or public cloud, you can initiate the built-in agent on the Citrix ADC instances in your environment. This agent enables communication between that instance and the Citrix ADM. Built-in agent is ideal for deployments that include an individual HA pair of Citrix ADC instances rather than a site with multiple Citrix ADC instances, as dedicated agent would provide better data aggregation capabilities than built-in agent.

The management, monitoring, and application dashboard features are supported for Citrix ADC instances using built-in agents. The following features are not supported in built-in agent: Web insight, SSL insight, HDX insight, Gateway insight, security insight, and advanced analytics.

Note

Built-in agent is available only on the following Citrix ADC instance types:

Citrix ADC MPX Appliance

Citrix ADC VPX Appliance

Citrix Gateway

Citrix Secure Web Gateway

To use the built-in agent, make sure that you upgrade your Citrix ADC instance to the version 12.0 build 56.20.

Prerequisites

Before you initiate the built-in agent on the Citrix ADC instance, ensure that you have:

Upgraded the Citrix ADC instance to the version 12.0.56.20.
Configured a DNS name server to the Citrix ADC instance.
Generated and copied the Service URL and the Activation Code from the Set Up Agents page in Citrix ADM.

Note

For all information related to ports and other requirements, see System Requirements.

Initiate built-in agent

To initiate the built-in agent on the Citrix ADC instance:

Using an SSH client, log on to your Citrix ADC instance.
Navigate to the /var/mastools/scripts/ directory and execute the mastools_init.sh script:

./mastools_init.sh <username> <password> <service_url> "<activation_code>"

Sample

Built-in

Once the built-in agent is initiated, click Register Instance on the Set Up Agents page in Citrix ADM to register the built-in agent with Citrix ADM.

The official version of this content is in English. Some of the Citrix documentation content is machine translated for your convenience only. Citrix has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Citrix product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Citrix, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Citrix will not be held responsible for any damage or issues that may arise from using machine-translated content.

Initiate built-in agent on the Citrix ADC instance

January 21, 2020

Contributed by: R C

Initiate built-in agent on the Citrix ADC instance

Prerequisites

Initiate built-in agent

Sample

Initiate built-in agent on the Citrix ADC instance

In this article