Product Documentation

Deploy a blueprint to a VMware vSphere 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 VMware vSphere resource location that you have added to Smart Tools (as described in Add a VMware vSphere resource location).

If you want to use vSphere as a resource location, but don’t want to supply the credentials needed to add it to Smart Tools, you can deploy blueprints using existing VMs 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 the 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 VMware vSphere 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 a VMware vSphere resource location.

    Note: If you intend to deploy the blueprint using existing VMs, 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 template 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.

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 VMware vSphere resource location from the list. The Configure VM dialog box appears.
  3. On the Choose Resource page, select a resource pool or cluster in which you want to run VMs and then click Next. This is applicable if you have a larger vSphere deployment with DRS clusters and resource pools configured. You can also select individual hosts to run the clusters.
  4. On the Name and Location page, configure the following settings and then click Next:

    • Create Server Method: Choose a a server creation method. To create a server using a prepared machine image, select Create from template. To create a server using an open virtualization format (OVF) VM template, select Deploy from OVF.
    • VM Name: Enter a name for the provisioned machine.
    • Choose Datastore: Select a datastore. The datastore can reside on a local hard drive or across the network on a FC or iSCSI storage area network.
    • Choose Template: If you selected Create from template as the server creation method, select an appropriate machine image from which the VM will be created.
    • Deploy from URL: If you selected Deploy from OVF as the server creation method, enter the OVF URL.
  5. On the Hardware Device page, configure the CPU, memory, and disk size of the provisioned VM and then click Next.
  6. (Optional) On the Networking page, click Customize Virtual Machines Network to configure the provisioned machine’s local Administrator credentials, workgroup or domain credentials, DNS server, and IP addressing. Click Next.
  7. On the Agent page, ensure that Install Citrix Smart Tools Agent on new VMs is selected and enter the guest credentials for the template that will be used to create the VM. Click Next.
  8. On the Summary page, review the configuration and click Finish. The Configure VM dialog box closes, returning you to the Size page.
  9. Click Next. The Configuration page appears.

To use existing machines

  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 type of 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. The deployment summary appears.

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.