This page has moved to docs.citrix.com. You can now find all Smart Tools documentation at the Citrix Product Documentation site. Please update any page links to the new URL: https://docs.citrix.com/en-us/smart-tools/smart-scale/add-site-smart-scale.html.
- Add a Site and install Site Agents
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.
Add a Site and install Site Agents
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.