Product Documentation

About blueprints and the Blueprint Designer

Important: This topic describes deprecated functions and will be removed from the documentation. For more information about deprecated functions in Smart Tools, see What’s New in Citrix Smart Tools.


Citrix Smart Tools enables you to deploy and configure the machines that host your applications and services through the use of blueprints. A blueprint is a process template that contains deployment topology, software, platform components, machine configuration, workflow of the deployment process, and teardown processes. You can design blueprints that include scripts and other blueprints.

You can also use blueprints to deploy scripts for running health checks on specific machines in your environment. For more information about check blueprints, see Use custom checks and alerts with Smart Check.

Checks and Blueprints catalog

Published blueprints are stored in the Checks and Blueprints catalog. The catalog contains blueprints developed and maintained by Citrix as well as other Smart Tools users. All Smart Tools users can access the blueprints in the catalog. For more information about the Checks and Blueprints catalog, see About the Checks and Blueprints catalog and Library.

Access blueprints

To use the blueprints in the Checks and Blueprints catalog, you must first add them to your library. Your library is your own personal space for storing the blueprints and scripts that you create, copy from a catalog, or that other users share with you. After you Add a check or blueprint to your account, you can include them within other blueprints or deploy them to your resource location. For more information about your library, see About the Checks and Blueprints catalog and Library.

Create and modify blueprints

To create or modify blueprints, use the Blueprint Designer. With the Blueprint Designer, you can create repeatable, automated blueprints that perform the following key cloud management activities through a series of specified actions:

  • Provisioning cloud resources (servers, storage, and network)
  • Installing and configuring cloud applications
  • Configuring systems and services
  • Managing instances, volumes, and network

Blueprints are built from other blueprints, scripts, sub-processes, and cloud and utility steps. After you create a blueprint, you can modify it and save multiple different versions or deploy to your resource location. Smart Tools automatically executes each step and sub-process as defined in the blueprint.

The Blueprint Designer includes the following sections you can use to configure your blueprint:

  • Overview: This tab contains the metadata for your blueprint such as friendly name, supported resource locations, and prerequisites for deployment.
  • Deploy: Use this tab to add blueprints or scripts for building and configuring your system architecture. This may include actions such as creating a new VM, configuring a domain, or installing an application.
  • Manage: Use this tab to add a teardown process to your blueprint. A teardown process is a series of steps that terminate the machines in your blueprint deployment.

Access the Blueprint Designer

  1. From the Smart Tools menu bar, click Smart Build. The Library page appears.
  2. To create a new blueprint, click New Blueprint.
  3. To edit an existing blueprint, point to the blueprint and, under Actions, click Actions > Edit. Smart Tools displays the blueprint or script in the Blueprint Designer, in a modifiable state.

Note: You can also view the blueprint in the Blueprint Designer by selecting the View action from your library. However, to modify the blueprint or script, you must first click More > Edit from the Blueprint Designer’s button bar. If the blueprint is not in a modifiable state, you cannot make any changes to the blueprint.

Naming requirements for new blueprints

Blueprint names cannot be blank and must include at least one character. Blueprint names that start with the following words are not allowed:

  • AutoBlueprint
  • Upgrade Analysis Blueprint
  • Update DDC Blueprint
  • Update VDA Machines
  • Update Master Image