Register or unregister DNS subdomains

This page has moved to You can now find all Smart Tools documentation at the Citrix Product Documentation site. Please update any page links to the new URL:



Smart Tools includes two built-in blueprint steps -- Register DNS and Unregister DNS -- that allow you to register or unregister a DNS subdomain to Smart Tools' public DNS domain ( as part of a blueprint deployment.

Use the Register DNS Step in a new or existing blueprint deployment. Use the Unregister DNS Step in the blueprint's Tear Down process. 

About specifying subdomain names

When you use the Register DNS step, you must provide a DNS subdomain name and an IP address. Smart Tools only accepts DNS subdomain names with alphanumeric characters and IPv4 addresses. 

When you specify the subdomain name, consider the following points: 

  • Duplicate DNS subdomain names: If you specify a DNS subdomain name that is already registered with Smart Tools, Smart Tools appends a number from 1 to 20 to the name. For example, if already exists, Smart Tools adds as a unique name to the DNS record. If 20 instances of your specified subdomain name already exist, Smart Tools generates a random number between 1 and 100,000 to use as the suffix for the DNS domain entry.
  • Restricted subdomain names: Subdomain names that violate ethical, cultural, or professional values are not allowed for DNS registration. Provide unique and friendly subdomain names.

Register a DNS subdomain 

Task 1: Create a blueprint with a Wait step

  1. Create a new blueprint as described in Create a blueprint.
  2. On the Deploy tab of the Blueprint Designer, in the left pane, expand Utility Step and drag and drop Wait Step into your blueprint. 
  3. In Wait Step, in Time to Wait, enter 5.
  4. Click Save to save the blueprint.

Task 2: Create a main blueprint

  1. Create a new blueprint as described in Create a blueprint.
  2. On the Deploy tab of the Blueprint Designer, in the left pane, expand Utility Step and drag and drop Register DNS Step into your blueprint. 
  3. In Register DNS Step, in the Inputs tab, enter the following details:
    • Subdomain name (required): This is a unique subdomain name that you want to register with Smart Tools' public DNS domain ( Enter only alphanumeric characters; special characters are not allowed. For example, if you enter acme123, the FQDN will be registered.
    • IP address (required): The valid IPv4 address associated with your subdomain. IPv6 addresses are not allowed. Example:
      Alternatively, you can refer the subdomain name and IP address values from the blueprint input parameters or from a previous server step in your blueprint.
  4. In the left pane, expand My Blueprint and drag and drop the Wait Step blueprint you created in Task 1 into the blueprint. 
  5. Expand the Wait Step blueprint and configure the default String parameter:
    1. Select the Blueprint Inputs tab and enter a Key value. In the Value column, click the reference tree icon clm-reference-tree-icon.png
    2. Expand the Register DNS Step outputs and select the Subdomain output parameter. Click OK

  6. Select the Global check box for the String parameter. 

  7. Click Save to save the blueprint.

Task 3: Deploy the blueprint

  1. From the Blueprint Designer button bar, click Deploy.
  2. Click Start deployment setup.
  3. Enter a name for the deployment, select a deployment profile (if available), and click Next.
  4. On the Resource Location page, select a resource location and click Next. 
  5. Review the Pre-deployment Checklist for the selected resource location and click Continue.
  6. On the Size page, configure machine instance details, if applicable. Click Next.
  7. On the Configuration page, click Next.
  8. (Optional) Enter a deployment profile name and click Save. Otherwise, click Cancel.
  9. On the Summary page, review the blueprint deployment configuration and click Deploy.

The Manage tab appears, displaying progress of your deployment. When the deployment finishes, the subdomain you specified in the previous task is registered with Smart Tools' public DNS domain.

Unregister a DNS subdomain 

  1. From the Smart Tools menu, click Manage. 
  2. Point to the completed blueprint deployment and click Details. 
  3. Click the Tear Down tab and click Configure. The Blueprint Designer appears, displaying the Tear Down tab.
  4. In the left pane, expand Utility Step and drag and drop Unregister DNS Step
  5. In Unregister DNS Step, in the Subdomain key, click the reference tree icon clm-reference-tree-icon.png.
  6. Expand the Wait Step blueprint outputs and select the global input parameter. Click OK.

  7. Click Save to save the blueprint.
  8. Click Tear down deployment and then click Tear down.

The scheduled teardown process decommissions the deployment and the subdomain unregisters from Smart Tools' public DNS domain.