Product Documentation

View or modify Site details

View Site information

  1. From the Smart Tools management console, click Smart Check or Smart Scale.
  2. On the XenApp and XenDesktop Sites page, locate the Site you want to manage.
  3. Click View (Smart Check) or View Site (Smart Scale).

Note: In Smart Check, Site details are not available for Sites without the Smart Tools Agent installed.

Smart Check Site information

Smart Check displays updates and task information for the Delivery Controllers and Machine Catalogs in your Site. Select one of the following tabs:

  • Health Alerts: Displays the alerts and applicable notifications for the Site components that you select.
  • Site Details: Displays the Delivery Controllers in your Site, the Smart Tools Agent status for each Delivery Controller, and the Delivery Groups in your Site. On this page, you can install the Smart Tools Agent on the other Delivery Controllers in your Site, update the Full Administrator credentials for the Site, refresh the Site data Smart Check uses, and remove the Site from view on the Smart Check and Smart Scale pages.

Smart Scale Site information

In Smart Scale, the monitoring, event information, and power status for registered machines in each Delivery Group is displayed. Select one of the following tabs:

  • Monitoring: Displays sessions in use, number of machines powered on, number of machines in maintenance mode, and load index. By default, data is displayed for the previous four hours. You can show data up to the previous 30 days.
  • Events: Displays the success or failure of executing scheduled items, powering machines on or off, and entering maintenance mode.
  • Machine Activity: Displays the current state of events for registered machines in the Delivery Group.
  • Machine Status: Displays the following information for machines in the Delivery Group:
    • Registration and power status
    • Whether or not the registration or power status was changed by Smart Tools
    • Maintenance mode status
    • Whether or not the maintenance mode status was changed by Smart Tools
  • Site Details: Displays the Delivery Controllers and the Smart Tools Agent status for each Delivery Group. You can also update the Full Administrator credentials for the Site, synchronize your Site’s data with Smart Tools, and remove the Site from the Smart Scale page.

Edit Site credentials

Your Site credentials are the Citrix administrator credentials that Smart Tools uses to impersonate the Site administrator and execute health checks or monitoring and scaling actions. You might need to edit your Site credentials if your Site did not register successfully when you added it to Smart Tools or if the account credentials were changed in Citrix Studio.

Note: If your Site uses the XenApp and XenDesktop Service in Citrix Cloud, this function is not available.

  1. From the Smart Tools management console, click Smart Check or Smart Scale.
  2. On the XenApp and XenDesktop Sites page, locate the Site you want to manage and click View or View Site.
  3. Click the Site Details tab and then click Edit Site Credentials.
  4. On the Edit Site page, enter the username (in domain\username format) and password of the Citrix administrator account you want to use.
  5. Click Done to save your changes.

Enable or disable event or issue notifications

Smart Tools can send you email notifications when health checks are performed and when Smart Scale experiences or resolves errors. By default, email notifications are disabled.

When enabled, Smart Tools sends email once per day, after the last scheduled check of the day finishes running.

  1. From the Smart Tools command bar, click Settings.
  2. Click Notifications.
  3. In Smart Check issues summary, click the toggle button to enable or disable notifications for Smart Check only.
  4. In Smart Scale error events, click the toggle button to enable or disable notifications for Smart Scale only.

To enable or disable all Smart Tools notifications, select or clear Send me notifications.

Sync Site data

By default, Smart Tools syncs the Site data in Smart Check or Smart Scale every four hours. You can manually force Smart Tools to sync the Site data at any time. For example, if you change the time zone of the Delivery Controllers in the Site, you can sync the Site data so Smart Check can reflect the change. However, no checks are performed and health reports are not updated.

  1. From the Smart Tools management console, click Smart Check or Smart Scale.
  2. On the XenApp and XenDesktop Sites page, locate the Site you want to refresh and click View or View Site.
  3. Click the Site Details tab and then click Sync Site Data.

Smart Tools displays a progress bar and refreshes the Site data. This process typically takes a few minutes to complete.

Remove a Site from Smart Tools

This section describes how to remove a Site so that it doesn’t appear in Smart Check and Smart Scale.

Remove a Site with the Smart Tools Agent installed

You can remove a Site using the following methods:

  • Remove the Site from Smart Tools (preferred). This method effectively unregisters the Site from Smart Tools. The Site no longer appears in Smart Check or Smart Scale. Smart Tools no longer monitors the Site, runs checks, or carries out scaling actions.
  • Remove the Site from view. This method removes the Site from view on the XenApp and XenDesktop Sites page in Smart Check and Smart Scale. Smart Tools stops all checks, monitoring, and scaling actions in progress. However, the Smart Tools Agent remains on all machines on which it was installed. This method can be helpful if:
    • You want to quickly remove a number of Sites from Smart Check without uninstalling the Smart Tools Agent from each one.
    • You uninstalled the Smart Tools Agent from all Delivery Controllers, but Smart Tools still displays the Site in Smart Check.

Note: When you remove a Site, Smart Tools doesn’t store any Smart Check alerts that were previously generated from health checks.

To remove a Site from Smart Tools

  1. Disable any scheduled checks, scaling actions, or capacity management triggers for the Site. If applicable, delete any schedules and clear any capacity management configurations for the Site.
  2. Uninstall the Smart Tools Agent from all Delivery Controllers in the Site. When all agents are removed, the Site no longer appears in Smart Check or Smart Scale.

To remove a Site from view

  1. On the XenApp and XenDesktop Sites page, locate the Site you want to remove.
  2. Choose one of the following methods:
    • Method 1 (Smart Check only):
      1. On the Site’s card, click Site Options and then click Remove Site.
      2. When prompted, click Remove.
    • Method 2 (Smart Check and Smart Scale):
      1. On the Site’s card, click View or View Site.
      2. Click Site Details and then click Remove Site. A message appears, prompting you to confirm removal.
      3. Click Remove. Smart Tools removes the Site from the Smart Check and Smart Scale pages.

Remove a XenApp and XenDesktop Service Site

By default, Smart Tools automatically discovers Sites using the XenApp and XenDesktop Service in Citrix Cloud. If you attempt to remove the Site from Smart Scale by clicking Site Details > Remove Site, Smart Tools automatically rediscovers the Site the next time you view the XenApp and XenDesktop Sites page in Smart Scale. This means a Site using the XenApp and XenDesktop Service currently cannot be removed from the Smart Scale page.

If you no longer want to use Smart Scale with your Site, you can:

  1. Disable any scheduled actions or capacity management triggers for the Site. To do this, click Smart Scale and then select the Site you want to modify. If applicable, delete any schedules and clear any capacity management configurations for the Site.
  2. Turn off Smart Scale for all Delivery Groups in the Site.

Turn off Smart Scale

When Smart Scale is turned off, monitoring and power management actions are disabled for all Delivery Groups in the Site. Although new monitoring data is no longer collected, you can still view previously-collected monitoring data.

Smart Tools turns off Smart Scale 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.

To turn off Smart Scale manually

  1. From the Smart Scale page, locate the Site you want to modify and click View Site.
  2. Click the menu button and select Turn Off Smart Scale for this Site.

    Menu button with Turn Off Smart Scale for this Site selected

    A message appears, prompting you to confirm turning off Smart Scale.

  3. Click Click Turn Off.

To turn Smart Scale back on, click Turn ON Smart Scale from any tab (Monitoring, Site Details, and so on). Afterward, Smart Scale resumes monitoring your Delivery Groups and you can re-enable power management for each Delivery Group in the Site.