close

keyboard_arrow_left

Table of Contents Expand all

play_arrow Introduction
- play_arrow Overview
- play_arrow Access and Manage Paragon Automation Account
play_arrow Administration
- play_arrow Introduction
  - Administration Overview
  - Administration Workflow
- play_arrow Organization Management
- play_arrow Site Management
- play_arrow User Management
- play_arrow Inventory Management
  - About the Inventory Page
  - Assign a Device to a Site
- play_arrow Audit Logs
  - Audit Logs Overview
  - About the Audit Logs Page
- play_arrow Tags
  - About the Tags Page
  - Manage Tags
play_arrow Device Life Cycle Management
- play_arrow Introduction
- play_arrow Day-Wise Activities for Device Life Cycle Management
- play_arrow Field Technician User Interface
  - Field Technician UI Overview
  - Working with Field Technician UI Pages
- play_arrow Onboarding Profiles
- play_arrow Plan Device Onboarding
- play_arrow View Device Onboarding
- play_arrow Device Management
play_arrow Observability
- play_arrow Introduction
  - Observability Overview
- play_arrow Health Dashboard
- play_arrow Troubleshoot Devices
- play_arrow View Network Topology
play_arrow Trust and Compliance
- play_arrow Introduction
  - Trust and Compliance Overview
  - Perform Compliance Scan and Manage Checklists
- play_arrow Manage Trust Settings and Trust Scores
- play_arrow Manage Compliance Scans
- play_arrow Manage Vulnerabilities
- play_arrow Monitor Integrity
play_arrow Service Orchestration
- play_arrow Introduction
  - Service Orchestration Overview
  - Service Provisioning Workflow
- play_arrow View Service Design Catalog
- play_arrow Manage Customers
- play_arrow Add Resources for Network Services
- play_arrow Manage Service Instances
- play_arrow Provision VPN Services
- play_arrow Monitor Service Order Execution Workflows
play_arrow Active Assurance
- play_arrow Introduction
- play_arrow Test Agents
- play_arrow Tests and Monitors
- play_arrow Test Templates
  - About the Test Templates Page
  - Create a Test Template
play_arrow Paragon Shell CLI Reference

list Table of Contents

English

keyboard_arrow_right

Add a Configuration Template

date_range 23-Aug-24

arrow_backward

arrow_forward

You must be a user assigned either the Super User or the Network Administrator role with the privilege to add configuration templates.

To add a configuration template:

Select Inventory > Devices > Configuration Templates.
The Configuration Templates page appears.
Click the Add icon (+).
The Add Configuration Template page appears.

Note:
Fields marked with an asterisk (*) are mandatory.
Configure the fields on the Basic Information tab according to the guidelines provided in Table 1.
Click Next to go to the Template Configuration tab.

Add the configuration on the Template Configuration tab.

You can do the following in the editor provided for entering the configuration:

Copy the required configuration stanza from a device and create a template from parameters in the configuration.
Parameterize variables by using double curly braces {{}}.

You can view a sample configuration by clicking the Sample Configuration link. The following are the sample configurations that are available:

Sample template configuration to configure interfaces on a device by using CLI:

content_copy zoom_out_map
configure
{% if interfaces and interfaces | length > 0 %}
{% for interface in interfaces %}
        set interfaces {{interface.name}} vlan-tagging
        {% for ifl in interface.ifls %}
        set interfaces {{interface.name}} unit {{ifl.unit}} vlan-id {{ifl.vlan_id}}
        {% for family in ifl.families %}
            set interfaces {{interface.name}} unit {{ifl.unit}} family {{family.name}} address {{family.address}}
        {% endfor %}
    {% endfor %}
{% endfor %}
{% endif %}
commit

Sample template configuration to configure interfaces on a device by using NETCONF EDIT and NETCONF RPC:

content_copy zoom_out_map
<edit-config>
<target><candidate /></target>
<default-operation>merge</default-operation>
<config>
  <configuration>
   <interfaces>
   {% for interface in interfaces %}
    <interface>
     <name>{{ interface.name }}</name>
     <vlan-tagging/>
     {% for ifl in interface.ifls %}
     <unit>
       <name>{{ifl.unit}}</name>
       <vlan-id>{{ifl.vlan_id}}</vlan-id>
       <family>
       {% for family in ifl.families %}
         <{{family.name}}>
           <address>
             <name>{{family.address}}</name>
           </address>
         </{{family.name}}>
     {% endfor %}
     </family>
     </unit>
     {% endfor %}
    </interface>
   {% endfor %}
   </interfaces>
  </configuration>
</config>
</edit-config>

Click Next to go to the Generated UI tab. You can view the parameters you set in the Template Configuration tab in the Generated UI tab.
Perform one or more actions on the Generated UI tab, as explained in Table 2.
Click Save.
A message indicating that the configuration template is added is displayed with a link to the Audits Logs page (Settings Menu > Audit Logs).

Table 1 lists fields to be entered on the Basic Information tab of the Add Configuration Templates page.

Table 1: Fields on the Basic Information Tab of the Add Configuration Templates Page
Field	Description
Template Name	Enter a unique name for the configuration template. The name can only contain alphanumeric characters, hyphen, period, and underscore; 64-characters maximum.
Description	Enter a description for the configuration template; 255-characters maximum.
Configuration Format	Select the output format for the configuration template: CLI (default) NETCONF EDIT NETCONF RPC NON EXECUTABLE
Device Family	Select a device family for which you are deploying the configuration template: ACX EX JNP JUNIPER ANY MX NFX PTX QFX

Table 2 lists the actions that you can perform on the Generated UI tab of the Add Configuration Templates page.

Table 2: Generated UI Actions (Add Configuration Template Page)
Action	Description
Reorder the UI	Drag and drop individual fields, grids, or sections to change the order in which the parameters appear on the UI.
Modify the settings for a field, section, or grid	To modify the settings for a field, section, or grid: Click the Settings (gear) icon next to the field, section, or grid. The Form Settings pane appears on the right side of the page, displaying the Basic Settings and Advanced Settings tabs. Modify the fields on these tabs, as needed. See Table 3 for an explanation of the fields on these tabs. Click Save Settings for each field to save your changes. The modifications that you made are displayed on the UI.
Reset the generated UI	Click Undo all Edits to discard the changes that you made and undo the changes made on the UI.
Preview configuration	Preview the configuration defined in the configuration template. To preview a configuration template: Click Preview Configuration. The Preview Configuration page appears, displaying the configuration that was rendered based on the values that you entered. Check if the configuration was rendered correctly. If the configuration was not rendered correctly, click the close (X) icon to go back to the Generated UI tab and make modifications as needed. If the configuration was rendered correctly, click OK. You are returned to the Generated UI page.

Table 3 lists the fields on the Form Settings pane.

Table 3: Form Settings (Add Configuration Template Page)
Setting	Guideline
Basic Settings Tab	Fields populated in this tab are based on the input type that you select for a parameter.
Input Type	The input type for the parameter in the configuration template. Select: Text (default): If the input value for the parameter is a string of characters. Number: If the input value for the parameter is a number. Email: If the input value for the parameter is an e-mail address. IPv4: If the input value for the parameter is an IPv4 address. IPv4 Prefix: If the input value for the parameter is an IPv4 prefix. IPv6: If the input value for the parameter is an IPv6 address. IPv6 Prefix: If the input value for the parameter is an IPv6 prefix. Toggle Button (Boolean): If the input value for the parameter is a Boolean value (true or false). Dropdown: If the input value for the parameter is selected from a list. Password: If the input value for the parameter is a password. The value that you enter is masked (default). (Optional) Click the Show Password (eye) icon to unmask the password. Confirm Password: If the input value for the parameter is to confirm the password. If you select this option, a Confirm Password field appears on the UI. The value that you enter is masked (default). (Optional) Click the Show Password (eye) icon to unmask the password.
Label	Enter the label that you want displayed (on the UI) for the parameter.
Default Value	Specify a default value for the parameter.
Validate	For Text input type, select one or more validation criteria against which the input value will be checked: No Space Alpha and Numeric Alpha, Numeric, and Dash Alpha, Numeric, and Underscore If the value that you entered for the parameter on the UI does not meet the selected validation criteria, an error message appears. Note: For greater control of input values, you can use the regular expression option in the Advanced Settings tab.
Description	Enter an explanation for the parameter, which will appear when you hover over the Help (?) icon for the parameter; the maximum length allowed is 256 characters.
Global Scope	Enable the toggle button to make the parameter common across all devices to which the configuration template is being deployed. A Global (G) icon is displayed beside the selected parameter. If you disable the toggle button, which is default, the parameter must be specified for each device.
Hidden	Click the toggle button to hide the parameter on the UI when you preview and deploy the template. Typically, this option is used to hide a parameter and display it in the template only when an event is triggered. By default, the toggle button is disabled, which means that the parameter is displayed.
Required	Click the toggle button to make the parameter mandatory; parameters that are mandatory are marked with an asterisk (*) on the UI.
Maximum Value	For parameters that are numbers, enter the maximum value (up to 16 digits) for the input.
Minimum Value	For parameters that are numbers, enter the minimum value (up to 16 digits) for the input.
Visibility for Disabled	For Boolean parameters, select one or more parameters that must appear on the UI when the toggle button is disabled (Boolean value is FALSE).
Visibility for Enabled	For Boolean parameters, select one or more parameters that must appear on the UI when the toggle button is enabled (Boolean value is TRUE).
Advanced Settings Tab
Regexp	Enter a regular expression (regex pattern) to validate the input value. A regular expression defines a search pattern that is used to match characters in a string. For example, the regular expression [A-Z] matches the input with the characters A through Z. If the input consists of characters other than A through Z, an error message (as specified in the Invalid Message field) appears.
Invalid Message	Enter an error message that you want to display on the UI when the input value does not match the specified regular expression.

What's Next

You can deploy the template on devices; see Deploy a Configuration Template to a Device.

arrow_backward PREVIOUS About the Configuration Templates Page

NEXT arrow_forward Edit and Delete a Configuration Template

Juniper Paragon Automation User Guide

Add a Configuration Template

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry

Juniper Paragon Automation User Guide

Add a Configuration Template

Related Documentation

Stay in touch