Product Documentation

Deploy a blueprint to an Amazon Web Services resource location

Important: The features in this topic have been deprecated and are no longer available in Smart Tools. This topic will be removed at a later time. For more information, see What’s New in Citrix Smart Tools.


This topic describes how to deploy a blueprint using an Amazon Web Services (AWS) resource location that you have added to Smart Tools (as described in Add an Amazon Web Services resource location.

If you want to use AWS as a resource location, but don’t want to supply the credentials and keys needed to add it to Smart Tools, you can deploy blueprints using existing AWS instances that you provision. To do this, see Deploy a blueprint using existing machines.

Step 1: Select the blueprint

  1. On the Library page, point to the blueprint you want to deploy.
  2. Under Actions, click Actions > Deploy. The blueprint description page appears.
  3. Click Start deployment setup. The Profile page appears.

Step 2: Name the deployment

  1. In Deployment name, enter a friendly name for your deployment.
  2. In Deployment profile, select an existing deployment profile with the deployment settings you want to use. Note: Deployment profiles are settings that are saved from a previous blueprint deployment. The deployment profile you select must match the blueprint you are deploying and the resource location you want to use. You cannot use a deployment profile that was created using a different blueprint or a different resource location. For more information, see About deployment profiles.

  3. Click Next. The Resource Location page appears.

Step 3: Select the resource location

  1. In Resource Location, select the Amazon EC2 resource location where you want to deploy the blueprint. If the resource location you want to use does not exist, click Add Resource Location and follow the steps described in Add an Amazon Web Services resource location.

    Note: If you intend to deploy the blueprint using existing AWS instances, select All Existing Machines.

  2. Click Next. The Pre-deployment Checklist appears.

Step 4: Review deployment requirements

The Pre-deployment Checklist displays recommendations for provisioned VMs, VM template requirements, and deployment parameters for your blueprint based on the resource location you previously selected. To save time configuring your deployment, you can download the deployment parameters, enter the appropriate values, and import the updated parameters later in the deployment process (see section Step 6: Enter deployment parameters in this topic).

  1. Review each section of the Pre-deployment Checklist to verify your VM templates and resource location meet the stated requirements.
  2. (Optional) Click Export parameter list to download the deployment parameters in CSV format. Enter the appropriate values using a text editor or spreadsheet application. You can import these parameters on the Configuration page of the deployment process.
  3. Click Continue. The Size page appears.

Step 5: Select machines for deployment

When you deploy the blueprint, Smart Tools can provision new VMs in your resource location or use existing machines that you specify for each machine tier in the blueprint. By default, the Create new VMs option is selected.

Important: If you want to use existing machines, the machines must have the Smart Tools Agent installed; otherwise, Smart Tools cannot locate them in your resource location. For more information about using existing machines to deploy blueprints, see Deploy a blueprint using existing machines.

To create new VMs during deployment

  1. Ensure Create new VMs is selected.
  2. Select the Amazon EC2 resource location from the list. The Configure VM dialog box appears.
  3. On the Choose a Region page, Select the appropriate region where the machine instance will run and click Next. The US East (Virginia) region is selected by default.
  4. On the Choose an AMI page, select an Amazon Machine Image (AMI) from the listed EC2 images.

    Note: Citrix recommends selecting a preconfigured image from the Quick Start tab. However, you can also choose your own custom images in the My AMIs tab; or choose from thousands of community-submitted Linux and Windows AMIs (with different application stacks included) in the Community AMIs tab. If you select a custom or Community Windows-based AMI, verify the image has the EC2Config service installed.

  5. On the Instance Details page, configure the instance and then click Next:
    • VM Name: Specify a friendly name.
    • Suffix start: Specify the number at which Smart Tools will start numbering instances when they are provisioned. If the specified number already exists in your resource location, Smart Tools will use the next number in sequence.
    • Network: Specify the virtual private cloud (VPC) where you want to run the instance. If the VPC you want to use does not exist, select Create VPC with public and private subnet and then perform the following actions:
      1. In VPC Name, enter a friendly name for your VPC.
      2. For the Public and Private subnets, enter the appropriate IP ranges and select the appropriate availability zones, if applicable, for your resource location. Some advanced production environments may deploy instances in multiple availability zones for failover purposes. For less critical deployments with fewer instances choose “No Preference.” Note: Data transfer between instances in different availability zones may incur additional costs to your AWS account.
      3. In NAT Instance Type, select the appropriate configuration for the machine that will be deployed as the NAT for the VPC. By default, T2 Micro is selected. If a NAT instance does not exist already in your resource location, Smart Tools will deploy one when it creates the VPC. By default, this instance is called “Citrix Nat Instance” and it is deployed to the VPC’s public subnet.
      4. In NAT Instance Key Pair, select a key pair, if applicable, that Smart Tools will use to deploy the NAT instance. By default, No Key Pair is selected. Selecting a key pair is not required. However, if you intend to connect to the instance in the future, you must select a key pair.
    • Subnet: Select the appropriate subnet for your blueprint. For most Citrix-provided blueprints, Smart Tools provides recommendations to guide you in selecting a subnet.
    • Instance Type: Select an appropriate machine configuration for the instance. For most Citrix-provided blueprints, Smart Tools displays instance recommendations to guide you in selecting an instance type.
    • (Optional) Root Volume Size: Enter the appropriate machine disk size in gigabytes (GB). Smart Tools displays the default root volume size. For most Citrix-provided blueprints, Smart Tools displays recommendations to guide you in selecting a root volume size.

    Important: When Smart Tools creates the new VPC, Smart Tools will also allocate a new Elastic IP for the NAT instance. Be sure you have not reached the Elastic IP limit of five (5) addresses for your AWS account.

  6. On the Credentials page, enter an existing private key for this AWS account or create a new key pair, ensure that Install Citrix Smart Tools Agent on new VMs is selected, and then click Next:

    • If using an existing private key, select the PEM file that you saved when you created the key pair and click Upload to attach it to the deployment configuration.
    • To create a new key pair, select Create Key Pair, enter a friendly name, and then click Create Key. Smart Tools displays your private key, which you must save and keep in a safe place. The key pair you create is tied to a specific region and cannot be shared among regions. If the region you select for your deployment has no corresponding key pair, you must create one from the Credentials page. For more information on EC2 key pairs, see the Amazon EC2 Product Documentation web site.
  7. On the Networking page, configure the following settings and then click Next:

    • Instance: If applicable, select an Elastic IP for the instance. By default, No Elastic IP is selected. To create a new Elastic IP address, select Allocate new Elastic IP address for this instance.

    Note: If the maximum number of Elastic IP addresses is reached, use the AWS console to release an Elastic IP.

    • Group Name: Select a security group for your instance. By default, the default group is selected. If the security group is not configured to allow Smart Tools to install the Smart Tools Agent on the instance, Smart Tools can modify the group during deployment. For more information about security groups, see the Amazon EC2 Product Documentation web site.
  8. On the Summary page, review the instance configuration and click Finish. The Configure VM dialog box closes, returning you to the Size page.

    Note: If you have multiple server steps configured in your blueprint, you can copy VM configuration data from one server tier to another during blueprint deployment. To copy the VM configuration data to other VM tiers, select Copy this configuration to other VM tiers. If the blueprint includes recommended configuration parameters for these tiers, the parameters are used appropriately.

  9. Click Next. The Configuration page appears.

To specify existing machines in the deployment

  1. Select Use existing machines.
  2. Select a machine from the list. After you select a machine, Smart Tools displays the IP address.
  3. Click Next. The Configuration page appears.

Step 6: Enter deployment parameters

  1. For each section of the blueprint, enter the appropriate parameters that Smart Tools will use to deploy the blueprint.
  2. (Optional) If you downloaded the deployment parameters from the Pre-deployment Checklist in Step 4: Review deployment requirements,” under Import parameters, click Choose File to upload the updated parameters in CSV format.
  3. Click Next.

Step 7: Create a deployment profile

Deployment profiles enable you to reuse your current deployment settings in the event you want to deploy the blueprint again to the same resource location. Using a deployment profile, you skip several steps in the deployment process, saving time and minimizing input errors. Creating a deployment profile is optional.

  1. Enter a friendly name for the profile.
  2. (Optional) Enter a description.
  3. Click Save. If you do not want to create a profile, click Cancel.

Step 8: Deploy the blueprint

  1. Review the deployment summary.
  2. Click Deploy.

After the deployment begins, Smart Tools displays the status of the deployment in the Deployment Details page. The Deployment Details page includes the real-time progress of each step in your blueprint. Depending on machine availability and the complexity of the blueprint, the deployment might take some time to complete, and some blueprint steps might take longer than others.