- What's new in Smart Tools
- Known issues
- About Citrix Cloud and Citrix Smart Tools
- Technical Security Overview for Citrix Smart Tools
- Open source attribution
- System Requirements
- Get Started
- Smart Tools Agent
- About blueprints and the Blueprint Designer
- About blueprint steps
- About scripts
- Add a new script
- Use named parameters in scripts
- Reference attachments in scripts
- Create a blueprint
- Provision VMs for your blueprint with the Server step
- Use Amazon EC2 APIs in your blueprint with the EC2 Generic Step
- Add conditional actions to your blueprint with the Conditional step
- Add server volumes to your blueprint with the Mount Volume step
- Register or unregister DNS subdomains
- Chain blueprint step outputs and inputs
- Create references to scripts and blueprints
- View and modify blueprints and scripts
- Publish a blueprint
- Clone a blueprint
- Share a blueprint or script
- About Smart Check
- About health checks
- Add a Site to Smart Check
- Discover a Site in Smart Check
- Perform health checks for your XenApp and XenDesktop Site
- Use custom checks and alerts with Smart Check
- View reports from health checks
- Manage Smart Check alerts and notifications
- Upload Site diagnostics to Citrix Technical Support
- View or modify a Site in Smart Check
- JSON format objects reference
- Smart Scale
- Smart Migrate
- Resource Locations
- Prepare Windows Server VM templates for deploying blueprints
- About the Checks and Blueprints catalog and Library
- About deployment profiles
- About the Pre-deployment Checklist
- Deploy a blueprint using existing machines
- Deploy a blueprint to a Citrix XenServer resource location
- Set static IP addresses for XenServer VM templates
- Deploy a blueprint to a Citrix CloudPlatform resource location
- Deploy a blueprint to a VMware vSphere resource location
- Set a static IP address for OVA files using VMware vSphere
- Deploy a blueprint to a Microsoft Hyper-V Server resource location
- Hyper-V VM prerequisite configurations
- Deploy a blueprint to Microsoft Azure Classic resource location
- Deploy a blueprint to an Amazon Web Services resource location
- Preparing Windows-based custom AMIs for Smart Tools
- Rerun a blueprint step during a deployment error
- Pause or cancel a deployment
- Deploy a script
Deploy Citrix Solutions Blueprints
- Deploy Citrix Solutions blueprints using existing machines
- Create a XenApp and XenDesktop production deployment on Microsoft Azure Classic
- Create a XenApp and XenDesktop production deployment on AWS
- Create a XenApp and XenDesktop production deployment with Provisioning Services on Citrix XenServer and VMware vSphere
- Deploy the Simple XenApp and XenDesktop Proof of Concept blueprint on Microsoft Azure Classic
- Deploy the Simple XenApp and XenDesktop Proof of Concept blueprint to AWS
- Deploy the XenApp and XenDesktop Proof of Concept blueprint on Citrix XenServer
- Deploy the XenApp and XenDesktop Proof of Concept blueprint on Microsoft Azure Classic
- Deploy the XenApp and XenDesktop Proof of Concept blueprint with NetScaler to AWS
- Deploy XenApp with the Secure Browser Service
- Deploy the XenMobile Enterprise or Advanced Edition blueprint
- Deploy the XenMobile MDM Edition blueprint
Deploy Resource Locations for Citrix Cloud
- Deploy the XenApp and XenDesktop Resource Location Setup blueprint on Citrix XenServer
- Deploy the XenApp and XenDesktop Resource Location Setup blueprint on Microsoft Azure Classic
- Deploy the XenApp and XenDesktop Resource Location Setup blueprint on AWS
- Deploy the XenApp and XenDesktop Resource Location Setup blueprint with an existing domain on AWS
- Manage Deployments
- Accounts and users
- REST API
- Troubleshoot agent connectivity issues
- Troubleshoot agent download and installation issues
- Troubleshoot blueprint creation issues
- Troubleshoot blueprint deployment issues
- Troubleshoot Site onboarding issues
- Troubleshoot removing Sites from Smart Tools
- Troubleshoot Smart Scale events
- Troubleshoot XenApp 6.x farm migration issues
About agents in Smart Tools
Smart Tools uses agents to facilitate communication with other machines and perform a variety of tasks such as monitoring, coordinating deployments, and collecting metrics. These agents are installed on machines that Smart Tools manages (for example, as in a blueprint deployment) or monitors (for example, for running health checks on or scaling XenApp and XenDesktop Sites).
This topic describes the following agents and how they are used:
- Smart Tools Agent
- Smart Tools Site Agent
The Smart Tools Agent is a lightweight software package that coordinates software deployment, collects metrics, and transmits logs. The agent has two functions:
- When installed on machines provisioned using a blueprint, the agent enables Smart Tools to configure each machine and install software required for the blueprint deployment (such as when deploying Citrix XenApp and XenDesktop). After deployment, the agent enables Smart Tools to monitor each machine.
- When installed on a machine designated as a connector, the agent acts as a point of contact between Smart Tools and the machines in a firewalled resource location (such as Citrix XenServer).
Smart Tools can install the agent automatically on new VMs that are provisioned as part of deploying a blueprint. You can also download the agent and install it manually. For more information about installing the agent, see the following topics:
A connector enables Smart Tools to communicate with machines in a resource location that resides behind a firewall. A connector is required for resource locations using Citrix XenServer, VMware vSphere, and Microsoft Hyper-V.
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.
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.
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
- From the XenApp and XenDesktop Sites page, locate the Site you want to manage and click View Site.
- Click the Site Details tab and then locate the Delivery Controller where you want to install the agent.
- 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.