Product Documentation

About the Smart Tools Agent

Important: This article has been deprecated and will be removed at a later time. The current version of this article is located at https://docs.citrix.com/en-us/smart-tools/smart-tools-agent/install-remove-smart-tools-agent.html.

The Smart Tools Agent is a lightweight software package that coordinates Smart Scale and Smart Check activities, collects metrics, and transmits logs.

To perform these functions, the Smart Tools Agent is installed on one or more Delivery Controllers in the XenApp and XenDesktop Site. You download and install the Smart Tools Agent when you add your Site to Smart Tools. Once installed, the Smart Tools Agent registers the site with Smart Tools, detects the Delivery Controllers and other components in your Site, and begins monitoring your Site.

Agent installation

Delivery Controllers hosting the Smart Tools Agent must meet the following requirements:

  • The Delivery Controller must support PowerShell 3.0, at a minimum.
  • No other agents are installed. For instructions for removing older versions of the agent, see Remove the agent.

For more information about installing the Smart Tools Agent, see Install or remove the Smart Tools Agent.

Ensure high availability of the Smart Tools Agent

To ensure Smart Tools can update your site without interruption, Citrix strongly recommends installing the Smart Tools Agent on multiple Delivery Controllers in your Site.

When you install the Smart Tools Agent on multiple Delivery Controllers, Smart Tools designates one of the Smart Tools Agents as the “active” agent. The active agent monitors the site and coordinates the actions you specify. the Smart Tools Agents residing on the other Delivery Controllers are idle and do not perform any of these activities. However, if the active agent is not available, Smart Tools designates an agent on another Delivery Controller as “active” so monitoring, scaling, and health check tasks can continue.

Agent status

When you add your Site, Smart Tools displays the following agent status for each of the Delivery Controllers in your Site:

To set up a connector, you install the Smart Tools Agent on a machine in your deployment environment and specify that machine as the connector when you add your resource location to Smart Tools. When you select the machine to be the connector, Smart Tools “promotes” the agent by installing additional software on the machine and adding the machine to the list of available connectors for the resource location.

You can specify the same machine to act as a connector between different resource locations. For example, the machine you specify as the connector for a Citrix XenServer resource location can also be specified when you configure a VMware vSphere resource location. To do this, the connector must be able to communicate with each environment you intend to use as resource locations.

For more information about setting up connectors, see Agent and connector requirements.

Smart Tools Site Agent

The Smart Tools Site Agent consists of the Smart Tools Agent and additional scripts that collect XenApp and XenDesktop Site information and coordinate Smart Scale and Smart Check activities.

To perform these functions, the Site Agent is installed on one or more Delivery Controllers in the XenApp and XenDesktop Site. You download and install the Site Agent when you add your Site to Smart Tools. Once installed, the Site Agent registers the site with Smart Tools, detects the Delivery Controllers and other components in your Site, and begins monitoring your Site.

Agent installation

Delivery Controllers hosting the Site Agent must meet the following requirements:

  • The Delivery Controller must support PowerShell 3.0, at a minimum.
  • Ensure any previously-installed Smart Tools Agent is removed from the Delivery Controller. If you deployed XenApp and XenDesktop with a Smart Tools blueprint, the Smart Tools Agent is installed on all servers in the deployment. To use Smart Scale or Upgrades & Updates, you must uninstall this agent from the Delivery Controller before you install the Site Agent.

For more information about installing the Site Agent, see the following topics:

Ensure high availability for the Site Agent

Citrix recommends installing the Site Agent on all the Delivery Controllers in your Site. This ensures Smart Tools can always perform Smart Check or Smart Scale functions in the event the agent on one Delivery Controller becomes unavailable.

When you install the Site Agent on multiple Delivery Controllers, Smart Tools designates one of the Site Agents as the “active” agent. The active agent monitors the site and coordinates the actions you specify. The Site Agents residing on the other Delivery Controllers are idle and do not perform any of these activities. However, if the active Site Agent is not available, Smart Tools designates a Site Agent on another Delivery Controller as “active” so monitoring, scaling, and health check tasks can continue.

To install the Site Agent on multiple Delivery Controllers

  1. From the XenApp and XenDesktop Sites page, locate the Site you want to manage and click View Site.
  2. Click the Site Details tab and then locate the Delivery Controller where you want to install the agent.
  3. Click Install Agent. Smart Tools installs the agent on the selected Delivery Controller.

On the Site Details page, the Delivery Controller displays “Online” for the agent status. Additionally, the Delivery Controller displays “Available” to indicate the agent is available to be the active agent if the currently active agent is offline.

Site Agent status

When you add your site, Smart Tools displays the following Site Agent status for each of the Delivery Controllers in your Site:

  • Active: The Site Agent is the primary agent performing monitoring and update actions that you have specified.
  • Available: The Site Agent is standing by and is not performing any monitoring or scaling actions. If the active agent is not available, this Site Agent can be designated as the new active agent.
  • Not Available: The Site Agent is not responding to communication from Smart Tools. This status might appear if the Site Agent is not installed on the Delivery Controller or the Delivery Controller hosting the agent is offline.

About the Smart Tools Agent