SovLabs Support Portal will be moving soon!

SovLabs Support

Submit a Ticket My Tickets

Use Sovlabs Template Engine to dynamically set the IPAM Profile


In this how to, we will run through how to fully template your IPAM profile so it can be made completely dynamic.  This document does this in the most simplistic way which is to show you how your IPAM Profile can be templated.   



Utilizing this method removes all API validation done from within the SovLabs engine. Inserting invalid or malformed data can cause multiple unknown issues from within the provisioning process. Use this method with extreme caution.



  • Have licensed your IPAM / DNS modules
  • Have an understanding of the template engine
  • You have already configured an IPAM Endpoint
  • This ONLY applies from SovLabs version 2019.10.0 and onwards


Setting up Property Definitions 

  1. Click on Administration (1) → Property Dictionary (2) → Property Definitions (3) → and click on New (4)

  2. Provide a Name (1) for your Property Definition and a label (2) that you will see on your blueprint

  3. Enter a description (optional)

  4. Set the data type (1) to String and the Required (2) to YES

  5. Set the Display As (1) to Dropdown and the values (2) as Static list

  6. In the static list, click on New (1), Enter the name of your subnet and the value which is the subnet (2).  In my example, I have set matching subnets. Then click OK (3)
    Repeat for all other networks you want to be able to select.
    NOTE:  You can provide different names to the value ie;  Production, Development, Test, DMZ etc (See second screen shot for example)
    1. My Example

    2. Example of multiple zones by name and value

  7. Click on OK

  8. Repeat the above steps to create a property definition for Gateway ,Network name and DNS Suffix

Setting up your IPAM Profile

  1. From your Catalog (1) search for IPAM Profile (2) and click on Request (3) in the Add IPAM Profile - SovLabs Module

  2. Provide a meaningful Configuration label (1) and Description (2)

  3. From the Type, select your IPAM endpoint type you will be using

  4. Select your IPAM providers endpoint that you have already configured

  5. Select the NIC number this will apply to (NOTE: The first network card on a VM is 0)

  6. In the Subnets, Gateways, Network name and network mask. This is where you will utilise the template engine.  Enter the values (1) you have setup in the previous steps to reflect the Dynamic nature of the network and press the green cross (2)

  7. Excluded IPs, if you have any enter them here, else leave this blank

  8. IN DNS Configuration, enter the Primary and secondary DNS IP Addresses you will use (1), and you can Template the DNS Suffix and DNS Search Suffix (2) as these will match the domain you will choose.

  9. You can configure WINS if you require, else this can be left blank

  10. Click on Submit

Updating you Blueprint

  1. Go to your blueprint and click Properties (1) → Property Groups (2) → and click Add (3)

  2. Locate your IPAM profile you created before, it will start with SovLabs-IPAMProfile-<Tenant>_ , place a check next to that one (1) and then click OK (2)

  3. Now click on Properties (1) → Custom properties (2) → and click New (3)

  4. Locate the Subnet property definition you created earlier and select this.

  5. In the show in Request field, place a check box

  6. Click on OK

  7. Repeat the above steps for Gateway, Network Name and Domain Suffix, you should end up with 4 additional Items in your Custom Properties

  8. Click on Finish

  9. When you deploy your blueprint, you will see the 4 additional options with drop downs that you can select that will build your IPAM profile network for you
    NOTE:  The examples below are of Gateway, Network Name and Subnet, I have used a common name for each zone, you could set the actual values as the name but this is an easy way to match each one.

Additional information

Template Engine:
IPAM profile:
IPAM integration Links:
Property Toolkit:

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.