- 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 Smart Check
Smart Check enables you to run regular health checks on your Citrix environment. Smart Check helps you find and fix issues before your users are impacted. With Smart Check, you can:
- Schedule and run a wide variety of health checks on your Site.
- Learn about any potential health issues affecting your Site.
- Find recommended fixes and product updates for the Delivery Controllers and Machine Catalogs in your Site.
- Easily upload Site diagnostics and share them with Citrix Support for analysis.
- View comprehensive reports about your Site’s health.
Smart Check is supported with the following Sites:
- Sites running XenApp and XenDesktop 7.x
Sites running on the following cloud providers and hypervisors:
- Amazon Web Services (AWS)
- Microsoft Azure Resource Manager
- Citrix XenServer 6.2, 6.5, 7.0, and 7.1
- VMware vSphere 5.1, 5.5, and 6.0
- Machine Catalogs that use Machine Creation Services (MCS)
Smart Check is not supported for deployments using the XenApp and XenDesktop Service in Citrix Cloud.
Supported Site components
Smart Check supports running health checks on the following Site components:
- Delivery Controllers
- Delivery Groups (created through XenDesktop or Provisioning Services)
- Machine Catalogs
- Provisioning Services
- Citrix License Server
When you add a Site to Smart Check, Smart Check runs a series of checks on the Delivery Controllers in your Site by default and displays results only for the Delivery Controllers, Delivery Groups, and Machine Catalogs. Afterward, you can run separate checks for any StoreFront, Provisioning Services, and Citrix License Server machines in your Site. For more information about these checks, see About health checks. You can also schedule these checks so that updated results for these components are added to the Health Report at regular intervals.
To take advantage of all Smart Check features, you must install the Smart Tools Site Agent on one or more Delivery Controllers in your XenApp and XenDesktop Site.
The Site Agent is a lightweight software package that allows Smart Tools to communicate with your Site over port 443 to collect Site information and run scheduled checks. Once installed, the agent registers your Site with Smart Check and Smart Scale and works with Smart Tools to detect the Delivery Controllers and Machine Catalogs in your Site, analyze your Site for issues, and search for applicable fixes and updates.
Citrix recommends installing the Site Agent on multiple Delivery Controllers so Smart Tools can always communicate with your Site to perform scheduled checks and look for applicable fixes and updates.
To install the agent successfully, Delivery Controllers must meet the following requirements:
- Support at least PowerShell 3.0.
- Allow outbound communication on port 443. The agent communicates with Smart Tools on this port to analyze your Site and coordinate health check activities.
For more information about installing the Site Agent, see Add a site to Smart Check.
To install the Smart Tools Site Agent on a Delivery Controller and add the Site, you need to have the Smart Tools Administrator role assigned to your Smart Tools account. Smart Tools users with the Architect or Operator roles can install the Site Agent on a Site but Smart Tools cannot successfully add the Site. By default, the Administrator role is automatically assigned when users are initially added to Smart Tools. For more information about Smart Tools user roles, see User roles and permissions.
When you install the Smart Tools Site Agent, you are prompted to supply an account that Smart Check can use to run checks and look for applicable fixes and updates for your Site. This account must meet the following minimum requirements:
- Member of the Domain Users group in Active Directory.
- Full Administrator role for the Site in Citrix Studio.
Requirements for using Smart Check without the agent
If you choose not to install the agent, you can still use Smart Check to perform manual health checks.
Smart Check can discover your Site using XenApp and XenDesktop Call Home or Citrix Scout. Smart Check analyzes Call Home and Citrix Scout data and displays potential issues or applicable updates.
For Smart Check to discover your Site, the following requirements must be met:
- Diagnostics uploads from your Site using Call Home or Citrix Scout must exist.
- You must use the same Citrix account that’s associated with those diagnostics uploads to access Smart Tools.
To perform health checks, you first use Call Home or Citrix Scout and then perform checks manually in Smart Check. After Smart Check analyzes your data, you can address any issues or updates using your own processes, outside of Smart Tools.
Important: To schedule all available health checks to run on your Site, you must install the Site Agent.