- 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
Add a Site to Smart Scale
Smart Scale displays XenApp and XenDesktop Sites using the following methods:
- Smart Scale discovers the Site automatically.
- You add the Site to Smart Scale by installing the Smart Tools Site Agent on at least one Delivery Controller in the Site.
When you click the Smart Scale menu tab to display the XenApp and XenDesktop Sites page, Smart Tools automatically discovers and displays the following Sites:
- Sites that use the XenApp and XenDesktop Service in Citrix Cloud.
- Sites where at least one Delivery Controller has the Smart Tools Site Agent installed. For example, you previously added the Site to Smart Check or you deployed your Site using a Smart Tools blueprint.
You can initiate discovery at any time by refreshing your browser.
Sites that are not automatically discovered must be added to Smart Scale by installing the Smart Tools Site Agent on at least one Delivery Controller.
You need to install the Site Agent and add your Site if one of the following applies:
- Your Site was deployed without using Smart Tools blueprints and the Site does not already have the Site Agent installed.
- Your Site was deployed with a Smart Tools blueprint that does not automatically install the Site Agent on Delivery Controllers during blueprint deployment. If you deployed your Site using the XenApp and XenDesktop with SQL blueprint, the XenApp and XenDesktop without SQL blueprint, or a custom blueprint that does not include the Register Site built-in step, you need to install the Site Agent and add your Site to Smart Scale.
To ensure Smart Tools can monitor and scale your Site without interruption, Citrix strongly recommends installing the Site Agent on multiple Delivery Controllers in your Site.
After you add your Site, Smart Tools analyzes it to discover the Delivery Controllers and Delivery Groups it contains. Smart Tools then displays the Site on the Smart Scale page. When you click Get Started, Smart Scale starts monitoring your Delivery Groups. After a few minutes, Smart Scale displays the data it collects on the Monitoring tab.
Note: Smart Tools can turn off Smart Scale for your Site automatically if none of your Delivery Groups are configured for power management or no Smart Scale events (such as powering machines on or off) have been generated in the last 30 days. When Smart Scale is turned off for your Site, no new monitoring data is captured, but you can still view previously-collected data on the Monitoring tab.
You can also turn off Smart Scale manually if you want to suspend monitoring and scaling actions.
Adding your Site to Smart Scale involves downloading and installing the Smart Tools Site Agent on at least one Delivery Controller in your Site. The agent enables Smart Tools to communicate with and monitor your Site and coordinate scaling actions.
After you add your Site, Smart Scale starts monitoring your Delivery Groups within a few minutes. To power manage Delivery Group machines, you need to enable Smart Scale for each Delivery Group in your Site. For more instructions, see Manage Delivery Group capacity with Smart Scale.
Before you set up Smart Scale for your Site, you must meet the following requirements:
- The Delivery Controller must support PowerShell 3.0, at a minimum.
- Ensure the Smart Tools Agent is not installed on the Delivery Controller. If you deployed your Site with a Smart Tools blueprint, the Smart Tools Agent is installed on all servers in the deployment. To use Smart Scale with your Site, you must uninstall this agent from the Delivery Controllers before you install the Site Agent.
Minimum user account requirements
After you install the Site Agent, Smart Tools prompts you to enter Citrix administrator credentials to set up Smart Scale. This allows Smart Tools to impersonate the administrator when performing monitoring and scaling activities. The Citrix administrator account you use must meet the following minimum requirements:
- The account is assigned the Delivery Group Administrator role in Citrix Studio.
- The account belongs to the Domain Users group in Active Directory.
To add a Site
Log on to a Delivery Controller as an administrator.
Note: If you log on as a domain user that does not belong to the Domain Admins group, you can still install the agent; however, Windows might prompt you for administrator credentials during installation. Windows requests these credentials if your account does not have sufficient permission to install the agent. Smart Tools does not store or transmit these credentials.
- Open a web browser and log on to the Smart Tools web site.
- From the menu bar, click Smart Scale.
- On the Smart Scale page, click Add Site.
- From the Add Site page, click Download Agent and then run the CitrixLifecycleManagementAgent.msi file. Follow the wizard to install the agent. After installation, the agent registers the Delivery Controller with Smart Tools, which can take a few minutes to complete. After registering successfully, the Add Site page displays a green check mark indicating successful installation. Click Next.
- Enter the username (in domain\username format) and password for the Citrix administrator account you want to use and then click Add Site. The Citrix administrator account must have either the Delivery Group Administrator or Full Administrator role.
To install the Site Agent on additional Delivery Controllers in your Site
- From the Smart Scale page, locate the Site you want to modify and click View Site.
- Click the Site Details tab and then locate the Delivery Controller where you want to install the Site Agent.
- Click Install Agent. Smart Tools installs the Site 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.