Product Documentation

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

If you want to use Hyper-V as a resource location, but don’t want to supply the information 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.


Before you deploy blueprints to your Hyper-V resource location, you must first prepare a virtual hard disk (VHD) file. A VHD is a hard disk file format of a virtual machine. Smart Tools uses the VHD file to create new VMs with the same configuration. For more information about preparing a VHD file for use with Smart Tools blueprints, see Prepare Windows Server VM templates for deploying blueprints.

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 Enter 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 a resource location

  1. In Resource Location, select the Microsoft Hyper-V 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 Microsoft Hyper-V Server 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 the 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 blueprint parameters in this topic). For more information on Pre-deployment Checklist page, see About pre-deployment checklist

  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 Microsoft Hyper-V resource location from the list. The Configure VM dialog box appears.
  3. On the Name page, enter a name for the VM and click Next.
  4. On the Operating System page, configure the following settings and then click Next:
    • Select VHD Location or VHD URL to enter the location or URL of your virtual hard disk (VHD) file. For example:
      • VHD Location: C:\Users\Public\Documents\Hyper-V\Virtual_hard_disks\Win-2012R2-sysprep.vhdx.
      • VHD URL: http://10.x.x.x/VHD/Win-2012R2-sysprep.vhdx">http://10.x.x.x/VHD/Win-2012R2-sysprep.vhdx
    • Click Get Disk Info. Disk information such as format, size, type appears.
    • Enter the VHD clone destination. This is the directory or storage location that contains your Hyper-V virtual hard disks. The Hyper-V host machine must have access to this directory. For example: C:\Users\Public\Documents\Hyper-V\Virtual_hard_disks
  5. On the Configuration page, configure the following settings and click Next:
    • CPU: Enter the number of CPUs.
    • Memory: Enter memory size.
    • If you want to increase the disk size from the existing size, select Increase disk size and enter a disk size based on your requirement.
    • IP Address: Select DHCP or Set Static IP based on your requirement. By default, DHCP is selected. To set a Static IP, select Set Static IP, enter IP details such as IP address, subnet mask, gateway and DNS server.
  6. On the Agent page, ensure the Install Citrix Smart Tools Agent on new VMs is selected and enter the VHD login credentials for the VM template that will be used to provision the machine. Click Next.
  7. On the Summary page, review the configuration and click Finish. The Configure VM dialog box closes, returning you to the Size page.
  8. 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 blueprint 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.