Product Documentation

Creating an entity template

You can create entity templates in either the AppExpert node or the Citrix ADC feature node that corresponds to the type of entity. For example, you can create a content switching virtual server template from the entity templates tab of the AppExpert feature’s Templates node or in the Content Switching node. You can also specify the parameters that you want the template to store, and specify whether you want the template import wizard to prompt the user for certain parameter values.

However, when creating load balancing virtual servers, you do not have the option of specifying parameter values that you want stored in the template. You create a load balancing virtual server template by selecting an existing load balancing virtual server and configuring any variables that you might want to create in existing parameters and bound policies. The variables can be assigned values when you create a load balancing virtual server from the template. The template stores load balancing parameters such as the virtual server’s IP address and port number, bound policies, actions, and variable definitions. A deployment file is also created, automatically, from the load balancing configuration. The deployment file stores deployment-specific information, such as information about bound services, service groups, and the name-value pairs of variables. If the bound entities that are included in the template are already configured on the Citrix ADC appliance to which the template is imported, duplicates are created, with names that are generated automatically in a particular format. The duplicate entities are based on the parameter information stored in the entity template.

When you create a load balancing virtual server template from the AppExpert node, the template is always saved to the /nsconfig/nstemplates/entities/lb vserver/ folder. If you want to save the template to a different folder, create the template from the Virtual Servers pane in the Load Balancing node. The deployment file is created with the name with which you save the template file, but with the string _deployment appended to the name. The deployment file is saved to the /nsconfig/nstemplates/entities/lb vserver/deployment_files/ folder. For more information about deployment files for load balancing virtual server templates, see “Understanding Load Balancing Entity Templates and Deployment Files.”

Note: You can use either of the first two procedures for creating any template, except for a load balancing virtual server template. For creating a load balancing virtual server template, use the third or fourth procedure.

To create an entity template by using its corresponding feature node

  1. Navigate to Traffic Management, and select the feature (for example, Content Switching), and then select the entity (for example, Virtual Servers), for which you want to create the entity template.
  2. At the top of the details pane, click Add to create a Template.
  3. In the Create…Template dialog box, follow the instructions to create a template.
  4. Click Finish, and then click Exit.

To create a load balancing virtual server template from the AppExpert node

  1. Navigate to AppExpert > Templates.
  2. In the details pane, on the LB Templates tab, click Add.
  3. In the Select Load Balancing Virtual Server dialog box, select the load balancing virtual server whose configuration you want to save to a template , and then click OK.
  4. In the Create Template dialog box, provide the following information:
    • Name. The name of the template.

      Note: The Folder field shows the location to which the template will be saved. You cannot modify the path that is displayed.

    • Configure Variables. Configure variables for the load balancing template. For more information, see “Configuring Variables in Load Balancing Virtual Server Templates.”

    • Introduction Description. A description of the virtual server for which you are creating a template.

    • Summary Description. A summary of the configuration or additional instructions for other administrators, such as a description of any additional steps that need to be followed after the entity is successfully created.

    • Author. The creator of the template.

    • Major. An optional major version number of your choice, to be specified if you want to maintain versions of your template.

    • Minor. An optional minor version number of your choice, to be specified if you want to maintain minor versions of your template.

      You can maintain versions by incrementing one or both of the version numbers each time you maintain the template. The Entity Template Wizard concatenates and displays the major and minor version numbers during import. For example, if the major version number is 1 and the minor version is 1, the Entity Template Wizard displays a version number of 1.1.

  5. Click OK.

To create a load balancing virtual server template from the Load Balancing Virtual Servers pane

  1. Navigate to Traffic Managemen > Load Balancing > Virtual Servers.
  2. In the details pane, select the virtual server on which to base the template, and then click Create Template. You might have to click the scroll arrow at the bottom right of the pane to bring the Create Template button into view.
  3. In the Create Template dialog box, provide the following information:
    • Name. The name of the template.

    • Folder. The location to which the template will be saved.

      Note: If you want to save the template to the appliance, you can save it only to the /nsconfig/nstemplates/entities/lb vserver/ directory (the path displayed by default in Folder. If you want to save the template file to a folder on your computer, click the down-arrow on the Browse button, click Local, and then select a folder.

    • Configure Variables. Configure variables for the load balancing template. For more information, see “Configuring Variables in Load Balancing Virtual Server Templates.”

    • Introduction Description. A description of the virtual server for which you are creating a template.

    • Summary Description. A summary of the configuration or additional instructions for other administrators, such as a description of any additional steps that need to be followed after the entity is successfully created.

    • Author. The creator of the template.

    • Major. An optional major version number of your choice, to be specified if you want to maintain versions of your template.

    • Minor. An optional minor version number of your choice, to be specified if you want to maintain minor versions of your template.

      You can maintain versions by incrementing one or both of the version numbers each time you maintain the template. The Entity Template Wizard concatenates and displays the major and minor version numbers during import. For example, if the major version number is 1 and the minor version is 1, the Entity Template Wizard displays a version number of 1.1.

  4. Click OK.